Class: Buildium::ApplicantsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/api/applicants_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApplicantsApi

Returns a new instance of ApplicantsApi.



19
20
21
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_applicant(applicant_post_message, opts = {}) ⇒ ApplicantMessage

Create an applicant Creates an applicant. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View` `Edit`

Parameters:

  • applicant_post_message (ApplicantPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 27

def create_applicant(applicant_post_message, opts = {})
  data, _status_code, _headers = create_applicant_with_http_info(applicant_post_message, opts)
  data
end

#create_applicant_group(applicant_group_post_message, opts = {}) ⇒ ApplicantGroupMessage

Create an applicant group Creates an applicant group. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View` `Edit`

Parameters:

Returns:



95
96
97
98
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 95

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_applicant_group_with_http_info(applicant_group_post_message, opts = {}) ⇒ Array<(ApplicantGroupMessage, Integer, Hash)>

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;

Parameters:

Returns:

  • (Array<(ApplicantGroupMessage, Integer, Hash)>) —

    ApplicantGroupMessage data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 105

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_applicant_note(applicant_id, note_post_message, opts = {}) ⇒ NoteMessage

Create an applicant note Creates an applicant note. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View` `Edit`

Parameters:

  • applicant_id (Integer)
  • note_post_message (NotePostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 164

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_applicant_note_with_http_info(applicant_id, note_post_message, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

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;

Parameters:

  • applicant_id (Integer)
  • note_post_message (NotePostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NoteMessage, Integer, Hash)>) —

    NoteMessage data, response status code and response headers



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 175

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_applicant_with_http_info(applicant_post_message, opts = {}) ⇒ Array<(ApplicantMessage, Integer, Hash)>

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;

Parameters:

  • applicant_post_message (ApplicantPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicantMessage, Integer, Hash)>) —

    ApplicantMessage data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 37

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_application_group_note(applicant_group_id, note_post_message, opts = {}) ⇒ NoteMessage

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`

Parameters:

  • applicant_group_id (Integer)
  • note_post_message (NotePostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 238

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_application_group_note_with_http_info(applicant_group_id, note_post_message, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

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;

Parameters:

  • applicant_group_id (Integer)
  • note_post_message (NotePostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NoteMessage, Integer, Hash)>) —

    NoteMessage data, response status code and response headers



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 249

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

#get_all_applicant_notes(applicant_id, opts = {}) ⇒ Array<NoteMessage>

Retrieve all applicant notes Retrieves all applicant notes. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View`

Parameters:

  • applicant_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :updateddatetimefrom (Time) —

    Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :updateddatetimeto (Time) —

    Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :lastupdatedbyuserid (Integer) —

    Filters results to only notes that were last updated by the specified user identifier.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



317
318
319
320
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 317

def get_all_applicant_notes(applicant_id, opts = {})
  data, _status_code, _headers = get_all_applicant_notes_with_http_info(applicant_id, opts)
  data
end

#get_all_applicant_notes_with_http_info(applicant_id, opts = {}) ⇒ Array<(Array<NoteMessage>, Integer, Hash)>

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;

Parameters:

  • applicant_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :updateddatetimefrom (Time) —

    Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :updateddatetimeto (Time) —

    Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :lastupdatedbyuserid (Integer) —

    Filters results to only notes that were last updated by the specified user identifier.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:

  • (Array<(Array<NoteMessage>, Integer, Hash)>) —

    Array<NoteMessage> data, response status code and response headers



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 333

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

#get_applicant_by_id(applicant_id, opts = {}) ⇒ ApplicantMessage

Retrieve an applicant Retrieves an applicant. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View`

Parameters:

  • applicant_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



392
393
394
395
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 392

def get_applicant_by_id(applicant_id, opts = {})
  data, _status_code, _headers = get_applicant_by_id_with_http_info(applicant_id, opts)
  data
end

#get_applicant_by_id_with_http_info(applicant_id, opts = {}) ⇒ Array<(ApplicantMessage, Integer, Hash)>

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;

Parameters:

  • applicant_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicantMessage, Integer, Hash)>) —

    ApplicantMessage data, response status code and response headers



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 402

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

#get_applicant_group_by_id(applicant_group_id, opts = {}) ⇒ ApplicantGroupMessage

Retrieve an applicant group Retrieves an applicant group. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View`

Parameters:

  • applicant_group_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



455
456
457
458
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 455

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

#get_applicant_group_by_id_with_http_info(applicant_group_id, opts = {}) ⇒ Array<(ApplicantGroupMessage, Integer, Hash)>

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;

Parameters:

  • applicant_group_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicantGroupMessage, Integer, Hash)>) —

    ApplicantGroupMessage data, response status code and response headers



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 465

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

#get_applicant_group_note_by_note_id(applicant_group_id, note_id, opts = {}) ⇒ NoteMessage

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`

Parameters:

  • applicant_group_id (Integer)
  • note_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



519
520
521
522
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 519

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

#get_applicant_group_note_by_note_id_with_http_info(applicant_group_id, note_id, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

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;

Parameters:

  • applicant_group_id (Integer)
  • note_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NoteMessage, Integer, Hash)>) —

    NoteMessage data, response status code and response headers



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 530

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

#get_applicant_group_notes(applicant_group_id, opts = {}) ⇒ Array<NoteMessage>

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`

Parameters:

  • applicant_group_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :updateddatetimefrom (Time) —

    Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :updateddatetimeto (Time) —

    Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :lastupdatedbyuserid (Integer) —

    Filters results to only notes that were last updated by the specified user identifier.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



593
594
595
596
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 593

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

#get_applicant_group_notes_with_http_info(applicant_group_id, opts = {}) ⇒ Array<(Array<NoteMessage>, Integer, Hash)>

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;

Parameters:

  • applicant_group_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :updateddatetimefrom (Time) —

    Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :updateddatetimeto (Time) —

    Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.

  • :lastupdatedbyuserid (Integer) —

    Filters results to only notes that were last updated by the specified user identifier.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:

  • (Array<(Array<NoteMessage>, Integer, Hash)>) —

    Array<NoteMessage> data, response status code and response headers



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 609

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

#get_applicant_groups(opts = {}) ⇒ Array<ApplicantGroupMessage>

Retrieve all applicant groups Retrieves all applicant groups. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :entitytype (String) —

    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.

  • :entityid (Integer) —

    Specifies the type of entity that &#x60;EntityId&#x60; refers to. This field is required if &#x60;EntityId&#x60; is specified.

  • :applicationgroupstatuses (Array<String>) —

    Filters results by the applicant group status. If no status is specified, applicant groups in any status will be returned.

  • :unitids (Array<Integer>) —

    Filters results to applicant groups associated to any of the specified rental property unit identifiers.

  • :name (String) —

    Filters results to applicant groups that includes applicants whose name contains the specified value.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



675
676
677
678
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 675

def get_applicant_groups(opts = {})
  data, _status_code, _headers = get_applicant_groups_with_http_info(opts)
  data
end

#get_applicant_groups_with_http_info(opts = {}) ⇒ Array<(Array<ApplicantGroupMessage>, Integer, Hash)>

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;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :entitytype (String) —

    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.

  • :entityid (Integer) —

    Specifies the type of entity that &#x60;EntityId&#x60; refers to. This field is required if &#x60;EntityId&#x60; is specified.

  • :applicationgroupstatuses (Array<String>) —

    Filters results by the applicant group status. If no status is specified, applicant groups in any status will be returned.

  • :unitids (Array<Integer>) —

    Filters results to applicant groups associated to any of the specified rental property unit identifiers.

  • :name (String) —

    Filters results to applicant groups that includes applicants whose name contains the specified value.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:

  • (Array<(Array<ApplicantGroupMessage>, Integer, Hash)>) —

    Array<ApplicantGroupMessage> data, response status code and response headers



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 692

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

#get_applicant_note_by_id(applicant_id, note_id, opts = {}) ⇒ NoteMessage

Retrieve an applicant note Retrieves an applicant note. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View`

Parameters:

  • applicant_id (Integer)
  • note_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



758
759
760
761
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 758

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

#get_applicant_note_by_id_with_http_info(applicant_id, note_id, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

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;

Parameters:

  • applicant_id (Integer)
  • note_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NoteMessage, Integer, Hash)>) —

    NoteMessage data, response status code and response headers



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 769

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

#get_applicants(opts = {}) ⇒ Array<ApplicantMessage>

Retrieve all applicants Retrieves all applicants. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :entityid (Integer) —

    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.

  • :entitytype (String) —

    Specifies the type of entity that &#x60;EntityId&#x60; refers to. This field is required if &#x60;EntityId&#x60; is specified.

  • :applicationstatuses (Array<String>) —

    Filters results by the applicant application status. If no status is specified, applicants with an application in any status will be returned.

  • :unitids (Array<Integer>) —

    Filters results to applicants associated to any of the specified rental property unit identifiers.

  • :name (String) —

    Filters results to applicants whose name contains the specified value.

  • :email (String) —

    Filters results to applicants whose email contains the specified value

  • :applicationsubmittedstartdate (Time) —

    Filters results to any applicant who submitted an application on or after the date specified.

  • :applicationsubmittedenddate (Time) —

    Filters results to any applicant who submitted an application on or prior to the date specified.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



836
837
838
839
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 836

def get_applicants(opts = {})
  data, _status_code, _headers = get_applicants_with_http_info(opts)
  data
end

#get_applicants_with_http_info(opts = {}) ⇒ Array<(Array<ApplicantMessage>, Integer, Hash)>

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;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :entityid (Integer) —

    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.

  • :entitytype (String) —

    Specifies the type of entity that &#x60;EntityId&#x60; refers to. This field is required if &#x60;EntityId&#x60; is specified.

  • :applicationstatuses (Array<String>) —

    Filters results by the applicant application status. If no status is specified, applicants with an application in any status will be returned.

  • :unitids (Array<Integer>) —

    Filters results to applicants associated to any of the specified rental property unit identifiers.

  • :name (String) —

    Filters results to applicants whose name contains the specified value.

  • :email (String) —

    Filters results to applicants whose email contains the specified value

  • :applicationsubmittedstartdate (Time) —

    Filters results to any applicant who submitted an application on or after the date specified.

  • :applicationsubmittedenddate (Time) —

    Filters results to any applicant who submitted an application on or prior to the date specified.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:

  • (Array<(Array<ApplicantMessage>, Integer, Hash)>) —

    Array<ApplicantMessage> data, response status code and response headers



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 856

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

#get_application_for_applicant_by_id(applicant_id, application_id, opts = {}) ⇒ ApplicationMessage

Retrieve an application Retrieves an application. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Applicants</span> - ‘View`

Parameters:

  • applicant_id (Integer)
  • application_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



925
926
927
928
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 925

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

#get_application_for_applicant_by_id_with_http_info(applicant_id, application_id, opts = {}) ⇒ Array<(ApplicationMessage, Integer, Hash)>

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;

Parameters:

  • applicant_id (Integer)
  • application_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicationMessage, Integer, Hash)>) —

    ApplicationMessage data, response status code and response headers



936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 936

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

#get_applications_for_applicant(applicant_id, opts = {}) ⇒ Array<ApplicationMessage>

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`

Parameters:

  • applicant_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



996
997
998
999
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 996

def get_applications_for_applicant(applicant_id, opts = {})
  data, _status_code, _headers = get_applications_for_applicant_with_http_info(applicant_id, opts)
  data
end

#get_applications_for_applicant_with_http_info(applicant_id, opts = {}) ⇒ Array<(Array<ApplicationMessage>, Integer, Hash)>

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;

Parameters:

  • applicant_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:

  • (Array<(Array<ApplicationMessage>, Integer, Hash)>) —

    Array<ApplicationMessage> data, response status code and response headers



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 1009

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_applicant(applicant_id, applicant_put_message, opts = {}) ⇒ ApplicantMessage

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`

Parameters:

  • applicant_id (Integer)
  • applicant_put_message (ApplicantPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1066
1067
1068
1069
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 1066

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_applicant_group(applicant_group_id, applicant_group_put_message, opts = {}) ⇒ ApplicantGroupMessage

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`

Parameters:

  • applicant_group_id (Integer)
  • applicant_group_put_message (ApplicantGroupPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1140
1141
1142
1143
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 1140

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_applicant_group_with_http_info(applicant_group_id, applicant_group_put_message, opts = {}) ⇒ Array<(ApplicantGroupMessage, Integer, Hash)>

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;

Parameters:

  • applicant_group_id (Integer)
  • applicant_group_put_message (ApplicantGroupPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicantGroupMessage, Integer, Hash)>) —

    ApplicantGroupMessage data, response status code and response headers



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 1151

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_applicant_with_http_info(applicant_id, applicant_put_message, opts = {}) ⇒ Array<(ApplicantMessage, Integer, Hash)>

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;

Parameters:

  • applicant_id (Integer)
  • applicant_put_message (ApplicantPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicantMessage, Integer, Hash)>) —

    ApplicantMessage data, response status code and response headers



1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 1077

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_application(applicant_id, application_id, application_put_message, opts = {}) ⇒ ApplicationMessage

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`

Parameters:

  • applicant_id (Integer)
  • application_id (Integer)
  • application_put_message (ApplicationPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1215
1216
1217
1218
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 1215

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_application_group_note(applicant_group_id, note_id, note_put_message, opts = {}) ⇒ NoteMessage

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`

Parameters:

  • applicant_group_id (Integer)
  • note_id (Integer)
  • note_put_message (NotePutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1295
1296
1297
1298
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 1295

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_application_group_note_with_http_info(applicant_group_id, note_id, note_put_message, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

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;

Parameters:

  • applicant_group_id (Integer)
  • note_id (Integer)
  • note_put_message (NotePutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NoteMessage, Integer, Hash)>) —

    NoteMessage data, response status code and response headers



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 1307

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

#update_application_with_http_info(applicant_id, application_id, application_put_message, opts = {}) ⇒ Array<(ApplicationMessage, Integer, Hash)>

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;

Parameters:

  • applicant_id (Integer)
  • application_id (Integer)
  • application_put_message (ApplicationPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicationMessage, Integer, Hash)>) —

    ApplicationMessage data, response status code and response headers



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/buildium-ruby/api/applicants_api.rb', line 1227

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