buildium-ruby 2.0.1

data/lib/buildium-ruby/api/applicants_api.rb

@@ -0,0 +1,1368 @@
+=begin
+#Open API, powered by Buildium
+
+#GetAllGLAccounts) 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 ApplicantsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create an applicant
+    # Creates an applicant.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View` `Edit`
+    # @param applicant_post_message [ApplicantPostMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicantMessage]
+    def create_applicant(applicant_post_message, opts = {})
+      data, _status_code, _headers = create_applicant_with_http_info(applicant_post_message, opts)
+      data
+    end
+
+    # Create an applicant
+    # Creates an applicant.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
+    # @param applicant_post_message [ApplicantPostMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicantMessage, Integer, Hash)>] ApplicantMessage data, response status code and response headers
+    def create_applicant_with_http_info(applicant_post_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.create_applicant ...'
+      end
+      # verify the required parameter 'applicant_post_message' is set
+      if @api_client.config.client_side_validation && applicant_post_message.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_post_message' when calling ApplicantsApi.create_applicant"
+      end
+      # resource path
+      local_var_path = '/v1/applicants'
+
+      # 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(applicant_post_message)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApplicantMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.create_applicant",
+        :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: ApplicantsApi#create_applicant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create an applicant group
+    # Creates an applicant group.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View` `Edit`
+    # @param applicant_group_post_message [ApplicantGroupPostMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicantGroupMessage]
+    def create_applicant_group(applicant_group_post_message, opts = {})
+      data, _status_code, _headers = create_applicant_group_with_http_info(applicant_group_post_message, opts)
+      data
+    end
+
+    # Create an applicant group
+    # Creates an applicant group.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
+    # @param applicant_group_post_message [ApplicantGroupPostMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicantGroupMessage, Integer, Hash)>] ApplicantGroupMessage data, response status code and response headers
+    def create_applicant_group_with_http_info(applicant_group_post_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.create_applicant_group ...'
+      end
+      # verify the required parameter 'applicant_group_post_message' is set
+      if @api_client.config.client_side_validation && applicant_group_post_message.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_group_post_message' when calling ApplicantsApi.create_applicant_group"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/groups'
+
+      # 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(applicant_group_post_message)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApplicantGroupMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.create_applicant_group",
+        :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: ApplicantsApi#create_applicant_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create an applicant note
+    # Creates an applicant note.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> -  `View` `Edit`
+    # @param applicant_id [Integer] 
+    # @param note_post_message [NotePostMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [NoteMessage]
+    def create_applicant_note(applicant_id, note_post_message, opts = {})
+      data, _status_code, _headers = create_applicant_note_with_http_info(applicant_id, note_post_message, opts)
+      data
+    end
+
+    # Create an applicant note
+    # Creates an applicant note.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; -  &#x60;View&#x60; &#x60;Edit&#x60;
+    # @param applicant_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_applicant_note_with_http_info(applicant_id, note_post_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.create_applicant_note ...'
+      end
+      # verify the required parameter 'applicant_id' is set
+      if @api_client.config.client_side_validation && applicant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_id' when calling ApplicantsApi.create_applicant_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 ApplicantsApi.create_applicant_note"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/{applicantId}/notes'.sub('{' + 'applicantId' + '}', CGI.escape(applicant_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 => :"ApplicantsApi.create_applicant_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: ApplicantsApi#create_applicant_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create an applicant group note
+    # Creates an applicant group note.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View` `Edit`
+    # @param applicant_group_id [Integer] 
+    # @param note_post_message [NotePostMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [NoteMessage]
+    def create_application_group_note(applicant_group_id, note_post_message, opts = {})
+      data, _status_code, _headers = create_application_group_note_with_http_info(applicant_group_id, note_post_message, opts)
+      data
+    end
+
+    # Create an applicant group note
+    # Creates an applicant group note.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
+    # @param applicant_group_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_application_group_note_with_http_info(applicant_group_id, note_post_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.create_application_group_note ...'
+      end
+      # verify the required parameter 'applicant_group_id' is set
+      if @api_client.config.client_side_validation && applicant_group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_group_id' when calling ApplicantsApi.create_application_group_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 ApplicantsApi.create_application_group_note"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/groups/{applicantGroupId}/notes'.sub('{' + 'applicantGroupId' + '}', CGI.escape(applicant_group_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 => :"ApplicantsApi.create_application_group_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: ApplicantsApi#create_application_group_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve all applicant notes
+    # Retrieves all applicant notes.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param applicant_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 &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<NoteMessage>]
+    def get_all_applicant_notes(applicant_id, opts = {})
+      data, _status_code, _headers = get_all_applicant_notes_with_http_info(applicant_id, opts)
+      data
+    end
+
+    # Retrieve all applicant notes
+    # Retrieves all applicant notes.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param applicant_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 &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<(Array<NoteMessage>, Integer, Hash)>] Array<NoteMessage> data, response status code and response headers
+    def get_all_applicant_notes_with_http_info(applicant_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_all_applicant_notes ...'
+      end
+      # verify the required parameter 'applicant_id' is set
+      if @api_client.config.client_side_validation && applicant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_id' when calling ApplicantsApi.get_all_applicant_notes"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/{applicantId}/notes'.sub('{' + 'applicantId' + '}', CGI.escape(applicant_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<NoteMessage>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.get_all_applicant_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: ApplicantsApi#get_all_applicant_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve an applicant
+    # Retrieves an applicant.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param applicant_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicantMessage]
+    def get_applicant_by_id(applicant_id, opts = {})
+      data, _status_code, _headers = get_applicant_by_id_with_http_info(applicant_id, opts)
+      data
+    end
+
+    # Retrieve an applicant
+    # Retrieves an applicant.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param applicant_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicantMessage, Integer, Hash)>] ApplicantMessage data, response status code and response headers
+    def get_applicant_by_id_with_http_info(applicant_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_applicant_by_id ...'
+      end
+      # verify the required parameter 'applicant_id' is set
+      if @api_client.config.client_side_validation && applicant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_id' when calling ApplicantsApi.get_applicant_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/{applicantId}'.sub('{' + 'applicantId' + '}', CGI.escape(applicant_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] || 'ApplicantMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.get_applicant_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: ApplicantsApi#get_applicant_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve an applicant group
+    # Retrieves an applicant group.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param applicant_group_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicantGroupMessage]
+    def get_applicant_group_by_id(applicant_group_id, opts = {})
+      data, _status_code, _headers = get_applicant_group_by_id_with_http_info(applicant_group_id, opts)
+      data
+    end
+
+    # Retrieve an applicant group
+    # Retrieves an applicant group.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param applicant_group_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicantGroupMessage, Integer, Hash)>] ApplicantGroupMessage data, response status code and response headers
+    def get_applicant_group_by_id_with_http_info(applicant_group_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_applicant_group_by_id ...'
+      end
+      # verify the required parameter 'applicant_group_id' is set
+      if @api_client.config.client_side_validation && applicant_group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_group_id' when calling ApplicantsApi.get_applicant_group_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/groups/{applicantGroupId}'.sub('{' + 'applicantGroupId' + '}', CGI.escape(applicant_group_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] || 'ApplicantGroupMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.get_applicant_group_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: ApplicantsApi#get_applicant_group_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve an applicant group note
+    # Retrieves an applicant group note.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param applicant_group_id [Integer] 
+    # @param note_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [NoteMessage]
+    def get_applicant_group_note_by_note_id(applicant_group_id, note_id, opts = {})
+      data, _status_code, _headers = get_applicant_group_note_by_note_id_with_http_info(applicant_group_id, note_id, opts)
+      data
+    end
+
+    # Retrieve an applicant group note
+    # Retrieves an applicant group note.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param applicant_group_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_applicant_group_note_by_note_id_with_http_info(applicant_group_id, note_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_applicant_group_note_by_note_id ...'
+      end
+      # verify the required parameter 'applicant_group_id' is set
+      if @api_client.config.client_side_validation && applicant_group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_group_id' when calling ApplicantsApi.get_applicant_group_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 ApplicantsApi.get_applicant_group_note_by_note_id"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/groups/{applicantGroupId}/notes/{noteId}'.sub('{' + 'applicantGroupId' + '}', CGI.escape(applicant_group_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 => :"ApplicantsApi.get_applicant_group_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: ApplicantsApi#get_applicant_group_note_by_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve all applicant group notes
+    # Retrieves all applicant group notes.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param applicant_group_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 &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<NoteMessage>]
+    def get_applicant_group_notes(applicant_group_id, opts = {})
+      data, _status_code, _headers = get_applicant_group_notes_with_http_info(applicant_group_id, opts)
+      data
+    end
+
+    # Retrieve all applicant group notes
+    # Retrieves all applicant group notes.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param applicant_group_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 &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<(Array<NoteMessage>, Integer, Hash)>] Array<NoteMessage> data, response status code and response headers
+    def get_applicant_group_notes_with_http_info(applicant_group_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_applicant_group_notes ...'
+      end
+      # verify the required parameter 'applicant_group_id' is set
+      if @api_client.config.client_side_validation && applicant_group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_group_id' when calling ApplicantsApi.get_applicant_group_notes"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/groups/{applicantGroupId}/notes'.sub('{' + 'applicantGroupId' + '}', CGI.escape(applicant_group_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<NoteMessage>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.get_applicant_group_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: ApplicantsApi#get_applicant_group_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve all applicant groups
+    # Retrieves all applicant groups.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :entitytype Filters results to any applicant groups associated with the specified entity identifier. This filter is used in conjunction with the &#x60;EntityType&#x60; field which must be set to the type of entity this identifier references.
+    # @option opts [Integer] :entityid Specifies the type of entity that &#x60;EntityId&#x60; refers to. This field is required if &#x60;EntityId&#x60; is specified.
+    # @option opts [Array<String>] :applicationgroupstatuses Filters results by the applicant group status. If no status is specified, applicant groups in any status will be returned.
+    # @option opts [Array<Integer>] :unitids Filters results to applicant groups associated to any of the specified rental property unit identifiers.
+    # @option opts [String] :name Filters results to applicant groups that includes applicants whose name *contains* the specified value.
+    # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<ApplicantGroupMessage>]
+    def get_applicant_groups(opts = {})
+      data, _status_code, _headers = get_applicant_groups_with_http_info(opts)
+      data
+    end
+
+    # Retrieve all applicant groups
+    # Retrieves all applicant groups.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :entitytype Filters results to any applicant groups associated with the specified entity identifier. This filter is used in conjunction with the &#x60;EntityType&#x60; field which must be set to the type of entity this identifier references.
+    # @option opts [Integer] :entityid Specifies the type of entity that &#x60;EntityId&#x60; refers to. This field is required if &#x60;EntityId&#x60; is specified.
+    # @option opts [Array<String>] :applicationgroupstatuses Filters results by the applicant group status. If no status is specified, applicant groups in any status will be returned.
+    # @option opts [Array<Integer>] :unitids Filters results to applicant groups associated to any of the specified rental property unit identifiers.
+    # @option opts [String] :name Filters results to applicant groups that includes applicants whose name *contains* the specified value.
+    # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<(Array<ApplicantGroupMessage>, Integer, Hash)>] Array<ApplicantGroupMessage> data, response status code and response headers
+    def get_applicant_groups_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_applicant_groups ...'
+      end
+      allowable_values = ["Rental", "RentalOwner"]
+      if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
+        fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["Undecided", "Approved", "Rejected", "AddedToLease", "Cancelled", "Deferred", "New"]
+      if @api_client.config.client_side_validation && opts[:'applicationgroupstatuses'] && !opts[:'applicationgroupstatuses'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"applicationgroupstatuses\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/groups'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
+      query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
+      query_params[:'applicationgroupstatuses'] = @api_client.build_collection_param(opts[:'applicationgroupstatuses'], :multi) if !opts[:'applicationgroupstatuses'].nil?
+      query_params[:'unitids'] = @api_client.build_collection_param(opts[:'unitids'], :multi) if !opts[:'unitids'].nil?
+      query_params[:'name'] = opts[:'name'] if !opts[:'name'].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<ApplicantGroupMessage>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.get_applicant_groups",
+        :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: ApplicantsApi#get_applicant_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve an applicant note
+    # Retrieves an applicant note.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param applicant_id [Integer] 
+    # @param note_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [NoteMessage]
+    def get_applicant_note_by_id(applicant_id, note_id, opts = {})
+      data, _status_code, _headers = get_applicant_note_by_id_with_http_info(applicant_id, note_id, opts)
+      data
+    end
+
+    # Retrieve an applicant note
+    # Retrieves an applicant note.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param applicant_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_applicant_note_by_id_with_http_info(applicant_id, note_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_applicant_note_by_id ...'
+      end
+      # verify the required parameter 'applicant_id' is set
+      if @api_client.config.client_side_validation && applicant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_id' when calling ApplicantsApi.get_applicant_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 ApplicantsApi.get_applicant_note_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/{applicantId}/notes/{noteId}'.sub('{' + 'applicantId' + '}', CGI.escape(applicant_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 => :"ApplicantsApi.get_applicant_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: ApplicantsApi#get_applicant_note_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve all applicants
+    # Retrieves all applicants.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :entityid Filters results to any applicant associated with the specified entity identifier. This filter is used in conjunction with the &#x60;EntityType&#x60; field which must be set to the type of entity this identifier references.
+    # @option opts [String] :entitytype Specifies the type of entity that &#x60;EntityId&#x60; refers to. This field is required if &#x60;EntityId&#x60; is specified.
+    # @option opts [Array<String>] :applicationstatuses Filters results by the applicant application status. If no status is specified, applicants with an application in any status will be returned.
+    # @option opts [Array<Integer>] :unitids Filters results to applicants associated to any of the specified rental property unit identifiers.
+    # @option opts [String] :name Filters results to applicants whose name *contains* the specified value.
+    # @option opts [String] :email Filters results to applicants whose email *contains* the specified value
+    # @option opts [Time] :applicationsubmittedstartdate Filters results to any applicant who submitted an application on or after the date specified.
+    # @option opts [Time] :applicationsubmittedenddate Filters results to any applicant who submitted an application on or prior to the date specified.
+    # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<ApplicantMessage>]
+    def get_applicants(opts = {})
+      data, _status_code, _headers = get_applicants_with_http_info(opts)
+      data
+    end
+
+    # Retrieve all applicants
+    # Retrieves all applicants.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :entityid Filters results to any applicant associated with the specified entity identifier. This filter is used in conjunction with the &#x60;EntityType&#x60; field which must be set to the type of entity this identifier references.
+    # @option opts [String] :entitytype Specifies the type of entity that &#x60;EntityId&#x60; refers to. This field is required if &#x60;EntityId&#x60; is specified.
+    # @option opts [Array<String>] :applicationstatuses Filters results by the applicant application status. If no status is specified, applicants with an application in any status will be returned.
+    # @option opts [Array<Integer>] :unitids Filters results to applicants associated to any of the specified rental property unit identifiers.
+    # @option opts [String] :name Filters results to applicants whose name *contains* the specified value.
+    # @option opts [String] :email Filters results to applicants whose email *contains* the specified value
+    # @option opts [Time] :applicationsubmittedstartdate Filters results to any applicant who submitted an application on or after the date specified.
+    # @option opts [Time] :applicationsubmittedenddate Filters results to any applicant who submitted an application on or prior to the date specified.
+    # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<(Array<ApplicantMessage>, Integer, Hash)>] Array<ApplicantMessage> data, response status code and response headers
+    def get_applicants_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_applicants ...'
+      end
+      allowable_values = ["Rental", "RentalOwner"]
+      if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
+        fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["Undecided", "Approved", "Rejected", "AddedToLease", "Cancelled", "Deferred", "New"]
+      if @api_client.config.client_side_validation && opts[:'applicationstatuses'] && !opts[:'applicationstatuses'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"applicationstatuses\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/applicants'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
+      query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
+      query_params[:'applicationstatuses'] = @api_client.build_collection_param(opts[:'applicationstatuses'], :multi) if !opts[:'applicationstatuses'].nil?
+      query_params[:'unitids'] = @api_client.build_collection_param(opts[:'unitids'], :multi) if !opts[:'unitids'].nil?
+      query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
+      query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
+      query_params[:'applicationsubmittedstartdate'] = opts[:'applicationsubmittedstartdate'] if !opts[:'applicationsubmittedstartdate'].nil?
+      query_params[:'applicationsubmittedenddate'] = opts[:'applicationsubmittedenddate'] if !opts[:'applicationsubmittedenddate'].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<ApplicantMessage>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.get_applicants",
+        :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: ApplicantsApi#get_applicants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve an application
+    # Retrieves an application.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param applicant_id [Integer] 
+    # @param application_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicationMessage]
+    def get_application_for_applicant_by_id(applicant_id, application_id, opts = {})
+      data, _status_code, _headers = get_application_for_applicant_by_id_with_http_info(applicant_id, application_id, opts)
+      data
+    end
+
+    # Retrieve an application
+    # Retrieves an application.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param applicant_id [Integer] 
+    # @param application_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicationMessage, Integer, Hash)>] ApplicationMessage data, response status code and response headers
+    def get_application_for_applicant_by_id_with_http_info(applicant_id, application_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_application_for_applicant_by_id ...'
+      end
+      # verify the required parameter 'applicant_id' is set
+      if @api_client.config.client_side_validation && applicant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_id' when calling ApplicantsApi.get_application_for_applicant_by_id"
+      end
+      # verify the required parameter 'application_id' is set
+      if @api_client.config.client_side_validation && application_id.nil?
+        fail ArgumentError, "Missing the required parameter 'application_id' when calling ApplicantsApi.get_application_for_applicant_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/{applicantId}/applications/{applicationId}'.sub('{' + 'applicantId' + '}', CGI.escape(applicant_id.to_s)).sub('{' + 'applicationId' + '}', CGI.escape(application_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] || 'ApplicationMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.get_application_for_applicant_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: ApplicantsApi#get_application_for_applicant_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve all applications
+    # Retrieves all the applications for a given applicant.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+    # @param applicant_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<ApplicationMessage>]
+    def get_applications_for_applicant(applicant_id, opts = {})
+      data, _status_code, _headers = get_applications_for_applicant_with_http_info(applicant_id, opts)
+      data
+    end
+
+    # Retrieve all applications
+    # Retrieves all the applications for a given applicant.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;
+    # @param applicant_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
+    # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
+    # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
+    # @return [Array<(Array<ApplicationMessage>, Integer, Hash)>] Array<ApplicationMessage> data, response status code and response headers
+    def get_applications_for_applicant_with_http_info(applicant_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.get_applications_for_applicant ...'
+      end
+      # verify the required parameter 'applicant_id' is set
+      if @api_client.config.client_side_validation && applicant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_id' when calling ApplicantsApi.get_applications_for_applicant"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/{applicantId}/applications'.sub('{' + 'applicantId' + '}', CGI.escape(applicant_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<ApplicationMessage>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.get_applications_for_applicant",
+        :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: ApplicantsApi#get_applications_for_applicant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an applicant
+    # Updates an applicant.              <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 &gt; Applicants</span> - `View` `Edit`
+    # @param applicant_id [Integer] 
+    # @param applicant_put_message [ApplicantPutMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicantMessage]
+    def update_applicant(applicant_id, applicant_put_message, opts = {})
+      data, _status_code, _headers = update_applicant_with_http_info(applicant_id, applicant_put_message, opts)
+      data
+    end
+
+    # Update an applicant
+    # Updates an applicant.              &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
+    # @param applicant_id [Integer] 
+    # @param applicant_put_message [ApplicantPutMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicantMessage, Integer, Hash)>] ApplicantMessage data, response status code and response headers
+    def update_applicant_with_http_info(applicant_id, applicant_put_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.update_applicant ...'
+      end
+      # verify the required parameter 'applicant_id' is set
+      if @api_client.config.client_side_validation && applicant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_id' when calling ApplicantsApi.update_applicant"
+      end
+      # verify the required parameter 'applicant_put_message' is set
+      if @api_client.config.client_side_validation && applicant_put_message.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_put_message' when calling ApplicantsApi.update_applicant"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/{applicantId}'.sub('{' + 'applicantId' + '}', CGI.escape(applicant_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(applicant_put_message)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApplicantMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.update_applicant",
+        :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: ApplicantsApi#update_applicant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an applicant group
+    # Updates an applicant group.              <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 &gt; Applicants</span> - `View` `Edit`
+    # @param applicant_group_id [Integer] 
+    # @param applicant_group_put_message [ApplicantGroupPutMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicantGroupMessage]
+    def update_applicant_group(applicant_group_id, applicant_group_put_message, opts = {})
+      data, _status_code, _headers = update_applicant_group_with_http_info(applicant_group_id, applicant_group_put_message, opts)
+      data
+    end
+
+    # Update an applicant group
+    # Updates an applicant group.              &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
+    # @param applicant_group_id [Integer] 
+    # @param applicant_group_put_message [ApplicantGroupPutMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicantGroupMessage, Integer, Hash)>] ApplicantGroupMessage data, response status code and response headers
+    def update_applicant_group_with_http_info(applicant_group_id, applicant_group_put_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.update_applicant_group ...'
+      end
+      # verify the required parameter 'applicant_group_id' is set
+      if @api_client.config.client_side_validation && applicant_group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_group_id' when calling ApplicantsApi.update_applicant_group"
+      end
+      # verify the required parameter 'applicant_group_put_message' is set
+      if @api_client.config.client_side_validation && applicant_group_put_message.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_group_put_message' when calling ApplicantsApi.update_applicant_group"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/groups/{applicantGroupId}'.sub('{' + 'applicantGroupId' + '}', CGI.escape(applicant_group_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(applicant_group_put_message)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApplicantGroupMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.update_applicant_group",
+        :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: ApplicantsApi#update_applicant_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an application
+    # Updates a rental application.              <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 &gt; Applicants</span> - `View` `Edit`
+    # @param applicant_id [Integer] 
+    # @param application_id [Integer] 
+    # @param application_put_message [ApplicationPutMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicationMessage]
+    def update_application(applicant_id, application_id, application_put_message, opts = {})
+      data, _status_code, _headers = update_application_with_http_info(applicant_id, application_id, application_put_message, opts)
+      data
+    end
+
+    # Update an application
+    # Updates a rental application.              &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
+    # @param applicant_id [Integer] 
+    # @param application_id [Integer] 
+    # @param application_put_message [ApplicationPutMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicationMessage, Integer, Hash)>] ApplicationMessage data, response status code and response headers
+    def update_application_with_http_info(applicant_id, application_id, application_put_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.update_application ...'
+      end
+      # verify the required parameter 'applicant_id' is set
+      if @api_client.config.client_side_validation && applicant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_id' when calling ApplicantsApi.update_application"
+      end
+      # verify the required parameter 'application_id' is set
+      if @api_client.config.client_side_validation && application_id.nil?
+        fail ArgumentError, "Missing the required parameter 'application_id' when calling ApplicantsApi.update_application"
+      end
+      # verify the required parameter 'application_put_message' is set
+      if @api_client.config.client_side_validation && application_put_message.nil?
+        fail ArgumentError, "Missing the required parameter 'application_put_message' when calling ApplicantsApi.update_application"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/{applicantId}/applications/{applicationId}'.sub('{' + 'applicantId' + '}', CGI.escape(applicant_id.to_s)).sub('{' + 'applicationId' + '}', CGI.escape(application_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(application_put_message)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApplicationMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
+
+      new_options = opts.merge(
+        :operation => :"ApplicantsApi.update_application",
+        :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: ApplicantsApi#update_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an applicant group note
+    # Updates an applicant group 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 &gt; Applicants</span> - `View` `Edit`
+    # @param applicant_group_id [Integer] 
+    # @param note_id [Integer] 
+    # @param note_put_message [NotePutMessage] 
+    # @param [Hash] opts the optional parameters
+    # @return [NoteMessage]
+    def update_application_group_note(applicant_group_id, note_id, note_put_message, opts = {})
+      data, _status_code, _headers = update_application_group_note_with_http_info(applicant_group_id, note_id, note_put_message, opts)
+      data
+    end
+
+    # Update an applicant group note
+    # Updates an applicant group note.              &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated.              &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
+    # @param applicant_group_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_application_group_note_with_http_info(applicant_group_id, note_id, note_put_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicantsApi.update_application_group_note ...'
+      end
+      # verify the required parameter 'applicant_group_id' is set
+      if @api_client.config.client_side_validation && applicant_group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_group_id' when calling ApplicantsApi.update_application_group_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 ApplicantsApi.update_application_group_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 ApplicantsApi.update_application_group_note"
+      end
+      # resource path
+      local_var_path = '/v1/applicants/groups/{applicantGroupId}/notes/{noteId}'.sub('{' + 'applicantGroupId' + '}', CGI.escape(applicant_group_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 => :"ApplicantsApi.update_application_group_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: ApplicantsApi#update_application_group_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end