Class: Propertyware::LeasesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/propertyware/api/leases_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LeasesApi

Returns a new instance of LeasesApi.



19
20
21
 
# File 'lib/propertyware/api/leases_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/propertyware/api/leases_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_comment_to_lease_conversation(lease_id, conversation_id, save_comment, opts = {}) ⇒ Comment

Add comment to a lease conversation (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Adds comment to a lease conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • lease_id (Integer) —

    Lease ID

  • conversation_id (Integer) —

    Conversation ID

  • save_comment (SaveComment) —

    saveComment

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/propertyware/api/leases_api.rb', line 29

def add_comment_to_lease_conversation(lease_id, conversation_id, save_comment, opts = {})
  data, _status_code, _headers = add_comment_to_lease_conversation_with_http_info(lease_id, conversation_id, save_comment, opts)
  data
end

#add_comment_to_lease_conversation_with_http_info(lease_id, conversation_id, save_comment, opts = {}) ⇒ Array<(Comment, Integer, Hash)>

Add comment to a lease conversation (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Adds comment to a lease conversation.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

  • conversation_id (Integer) —

    Conversation ID

  • save_comment (SaveComment) —

    saveComment

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

    the optional parameters

Returns:

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

    Comment data, response status code and response headers



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
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/propertyware/api/leases_api.rb', line 41

def add_comment_to_lease_conversation_with_http_info(lease_id, conversation_id, save_comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.add_comment_to_lease_conversation ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.add_comment_to_lease_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling LeasesApi.add_comment_to_lease_conversation"
  end
  # verify the required parameter 'save_comment' is set
  if @api_client.config.client_side_validation && save_comment.nil?
    fail ArgumentError, "Missing the required parameter 'save_comment' when calling LeasesApi.add_comment_to_lease_conversation"
  end
  # resource path
  local_var_path = '/leases/{leaseID}/conversations/{conversationID}/comments'.sub('{' + 'leaseID' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'conversationID' + '}', CGI.escape(conversation_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(save_comment)

  # return_type
  return_type = opts[:debug_return_type] || 'Comment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.add_comment_to_lease_conversation",
    :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: LeasesApi#add_comment_to_lease_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_journal_entry(save_lease_journal_entry, opts = {}) ⇒ JournalEntry

Create a lease journal entry (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a lease journal entry.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • save_lease_journal_entry (SaveLeaseJournalEntry) —

    saveLeaseJournalEntry

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

    the optional parameters

Returns:



107
108
109
110
 
# File 'lib/propertyware/api/leases_api.rb', line 107

def create_journal_entry(save_lease_journal_entry, opts = {})
  data, _status_code, _headers = create_journal_entry_with_http_info(save_lease_journal_entry, opts)
  data
end

#create_journal_entry_with_http_info(save_lease_journal_entry, opts = {}) ⇒ Array<(JournalEntry, Integer, Hash)>

Create a lease journal entry (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a lease journal entry.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_lease_journal_entry (SaveLeaseJournalEntry) —

    saveLeaseJournalEntry

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

    the optional parameters

Returns:

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

    JournalEntry data, response status code and response headers



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
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/propertyware/api/leases_api.rb', line 117

def create_journal_entry_with_http_info(save_lease_journal_entry, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.create_journal_entry ...'
  end
  # verify the required parameter 'save_lease_journal_entry' is set
  if @api_client.config.client_side_validation && save_lease_journal_entry.nil?
    fail ArgumentError, "Missing the required parameter 'save_lease_journal_entry' when calling LeasesApi.create_journal_entry"
  end
  # resource path
  local_var_path = '/leases/journalentries'

  # 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(save_lease_journal_entry)

  # return_type
  return_type = opts[:debug_return_type] || 'JournalEntry'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.create_journal_entry",
    :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: LeasesApi#create_journal_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_lease(save_lease, opts = {}) ⇒ Lease

Create a lease (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a new lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • save_lease (SaveLease) —

    saveLease

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

    the optional parameters

Returns:



175
176
177
178
 
# File 'lib/propertyware/api/leases_api.rb', line 175

def create_lease(save_lease, opts = {})
  data, _status_code, _headers = create_lease_with_http_info(save_lease, opts)
  data
end

#create_lease_adjustment(save_adjustment, opts = {}) ⇒ Adjustment

Create a lease adjustment (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a lease adjustment.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • save_adjustment (SaveAdjustment) —

    saveAdjustment

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

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/propertyware/api/leases_api.rb', line 243

def create_lease_adjustment(save_adjustment, opts = {})
  data, _status_code, _headers = create_lease_adjustment_with_http_info(save_adjustment, opts)
  data
end

#create_lease_adjustment_with_http_info(save_adjustment, opts = {}) ⇒ Array<(Adjustment, Integer, Hash)>

Create a lease adjustment (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a lease adjustment.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_adjustment (SaveAdjustment) —

    saveAdjustment

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

    the optional parameters

Returns:

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

    Adjustment data, response status code and response headers



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/propertyware/api/leases_api.rb', line 253

def create_lease_adjustment_with_http_info(save_adjustment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_adjustment ...'
  end
  # verify the required parameter 'save_adjustment' is set
  if @api_client.config.client_side_validation && save_adjustment.nil?
    fail ArgumentError, "Missing the required parameter 'save_adjustment' when calling LeasesApi.create_lease_adjustment"
  end
  # resource path
  local_var_path = '/leases/adjustments'

  # 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(save_adjustment)

  # return_type
  return_type = opts[:debug_return_type] || 'Adjustment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.create_lease_adjustment",
    :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: LeasesApi#create_lease_adjustment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_lease_charge(save_charge, opts = {}) ⇒ ChargeTx

Create a lease charge (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a lease charge.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • save_charge (SaveCharge) —

    saveCharge

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

    the optional parameters

Returns:



311
312
313
314
 
# File 'lib/propertyware/api/leases_api.rb', line 311

def create_lease_charge(save_charge, opts = {})
  data, _status_code, _headers = create_lease_charge_with_http_info(save_charge, opts)
  data
end

#create_lease_charge_with_http_info(save_charge, opts = {}) ⇒ Array<(ChargeTx, Integer, Hash)>

Create a lease charge (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a lease charge.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_charge (SaveCharge) —

    saveCharge

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

    the optional parameters

Returns:

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

    ChargeTx data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
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
 
# File 'lib/propertyware/api/leases_api.rb', line 321

def create_lease_charge_with_http_info(save_charge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_charge ...'
  end
  # verify the required parameter 'save_charge' is set
  if @api_client.config.client_side_validation && save_charge.nil?
    fail ArgumentError, "Missing the required parameter 'save_charge' when calling LeasesApi.create_lease_charge"
  end
  # resource path
  local_var_path = '/leases/charges'

  # 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(save_charge)

  # return_type
  return_type = opts[:debug_return_type] || 'ChargeTx'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.create_lease_charge",
    :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: LeasesApi#create_lease_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_lease_charges(save_charge, opts = {}) ⇒ Array<RESTAPIBulkSuccessResponse>

Create lease charges in bulk (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates lease charges in bulk.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • save_charge (Array<SaveCharge>) —

    saveCharge

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

    the optional parameters

Returns:



379
380
381
382
 
# File 'lib/propertyware/api/leases_api.rb', line 379

def create_lease_charges(save_charge, opts = {})
  data, _status_code, _headers = create_lease_charges_with_http_info(save_charge, opts)
  data
end

#create_lease_charges_with_http_info(save_charge, opts = {}) ⇒ Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>

Create lease charges in bulk (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates lease charges in bulk.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_charge (Array<SaveCharge>) —

    saveCharge

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

    the optional parameters

Returns:

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

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



389
390
391
392
393
394
395
396
397
398
399
400
401
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
 
# File 'lib/propertyware/api/leases_api.rb', line 389

def create_lease_charges_with_http_info(save_charge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_charges ...'
  end
  # verify the required parameter 'save_charge' is set
  if @api_client.config.client_side_validation && save_charge.nil?
    fail ArgumentError, "Missing the required parameter 'save_charge' when calling LeasesApi.create_lease_charges"
  end
  # resource path
  local_var_path = '/leases/charges/bulk'

  # 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(save_charge)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<RESTAPIBulkSuccessResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.create_lease_charges",
    :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: LeasesApi#create_lease_charges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_lease_conversation(lease_id, save_conversation, opts = {}) ⇒ Conversation

Create a lease conversation (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a specific lease conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • lease_id (Integer) —

    Lease ID

  • save_conversation (SaveConversation) —

    saveConversation

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

    the optional parameters

Returns:



448
449
450
451
 
# File 'lib/propertyware/api/leases_api.rb', line 448

def create_lease_conversation(lease_id, save_conversation, opts = {})
  data, _status_code, _headers = create_lease_conversation_with_http_info(lease_id, save_conversation, opts)
  data
end

#create_lease_conversation_with_http_info(lease_id, save_conversation, opts = {}) ⇒ Array<(Conversation, Integer, Hash)>

Create a lease conversation (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a specific lease conversation.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

  • save_conversation (SaveConversation) —

    saveConversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



459
460
461
462
463
464
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
512
513
514
 
# File 'lib/propertyware/api/leases_api.rb', line 459

def create_lease_conversation_with_http_info(lease_id, save_conversation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_conversation ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_conversation"
  end
  # verify the required parameter 'save_conversation' is set
  if @api_client.config.client_side_validation && save_conversation.nil?
    fail ArgumentError, "Missing the required parameter 'save_conversation' when calling LeasesApi.create_lease_conversation"
  end
  # resource path
  local_var_path = '/leases/{leaseID}/conversations'.sub('{' + 'leaseID' + '}', CGI.escape(lease_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(save_conversation)

  # return_type
  return_type = opts[:debug_return_type] || 'Conversation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.create_lease_conversation",
    :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: LeasesApi#create_lease_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_lease_discount(save_discount, opts = {}) ⇒ Discount

Create a lease discount (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a lease discount.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • save_discount (SaveDiscount) —

    saveDiscount

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

    the optional parameters

Returns:



521
522
523
524
 
# File 'lib/propertyware/api/leases_api.rb', line 521

def create_lease_discount(save_discount, opts = {})
  data, _status_code, _headers = create_lease_discount_with_http_info(save_discount, opts)
  data
end

#create_lease_discount_with_http_info(save_discount, opts = {}) ⇒ Array<(Discount, Integer, Hash)>

Create a lease discount (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a lease discount.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_discount (SaveDiscount) —

    saveDiscount

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

    the optional parameters

Returns:

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

    Discount data, response status code and response headers



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
581
582
 
# File 'lib/propertyware/api/leases_api.rb', line 531

def create_lease_discount_with_http_info(save_discount, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_discount ...'
  end
  # verify the required parameter 'save_discount' is set
  if @api_client.config.client_side_validation && save_discount.nil?
    fail ArgumentError, "Missing the required parameter 'save_discount' when calling LeasesApi.create_lease_discount"
  end
  # resource path
  local_var_path = '/leases/discounts'

  # 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(save_discount)

  # return_type
  return_type = opts[:debug_return_type] || 'Discount'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.create_lease_discount",
    :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: LeasesApi#create_lease_discount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_lease_payment(save_payment, opts = {}) ⇒ Payment

Create a lease payment (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a lease payment.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • save_payment (SavePayment) —

    savePayment

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

    the optional parameters

Returns:



589
590
591
592
 
# File 'lib/propertyware/api/leases_api.rb', line 589

def create_lease_payment(save_payment, opts = {})
  data, _status_code, _headers = create_lease_payment_with_http_info(save_payment, opts)
  data
end

#create_lease_payment_with_http_info(save_payment, opts = {}) ⇒ Array<(Payment, Integer, Hash)>

Create a lease payment (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a lease payment.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_payment (SavePayment) —

    savePayment

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



599
600
601
602
603
604
605
606
607
608
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
 
# File 'lib/propertyware/api/leases_api.rb', line 599

def create_lease_payment_with_http_info(save_payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_payment ...'
  end
  # verify the required parameter 'save_payment' is set
  if @api_client.config.client_side_validation && save_payment.nil?
    fail ArgumentError, "Missing the required parameter 'save_payment' when calling LeasesApi.create_lease_payment"
  end
  # resource path
  local_var_path = '/leases/payments'

  # 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(save_payment)

  # return_type
  return_type = opts[:debug_return_type] || 'Payment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.create_lease_payment",
    :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: LeasesApi#create_lease_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_lease_refund(save_refund, opts = {}) ⇒ Refund

Create a lease refund (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a lease refund.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • save_refund (SaveRefund) —

    saveRefund

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

    the optional parameters

Returns:



657
658
659
660
 
# File 'lib/propertyware/api/leases_api.rb', line 657

def create_lease_refund(save_refund, opts = {})
  data, _status_code, _headers = create_lease_refund_with_http_info(save_refund, opts)
  data
end

#create_lease_refund_with_http_info(save_refund, opts = {}) ⇒ Array<(Refund, Integer, Hash)>

Create a lease refund (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a lease refund.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_refund (SaveRefund) —

    saveRefund

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

    the optional parameters

Returns:

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

    Refund data, response status code and response headers



667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
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
 
# File 'lib/propertyware/api/leases_api.rb', line 667

def create_lease_refund_with_http_info(save_refund, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_refund ...'
  end
  # verify the required parameter 'save_refund' is set
  if @api_client.config.client_side_validation && save_refund.nil?
    fail ArgumentError, "Missing the required parameter 'save_refund' when calling LeasesApi.create_lease_refund"
  end
  # resource path
  local_var_path = '/leases/refunds'

  # 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(save_refund)

  # return_type
  return_type = opts[:debug_return_type] || 'Refund'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.create_lease_refund",
    :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: LeasesApi#create_lease_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_lease_with_http_info(save_lease, opts = {}) ⇒ Array<(Lease, Integer, Hash)>

Create a lease (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a new lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_lease (SaveLease) —

    saveLease

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

    the optional parameters

Returns:

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

    Lease data, response status code and response headers



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
231
232
233
234
235
236
 
# File 'lib/propertyware/api/leases_api.rb', line 185

def create_lease_with_http_info(save_lease, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease ...'
  end
  # verify the required parameter 'save_lease' is set
  if @api_client.config.client_side_validation && save_lease.nil?
    fail ArgumentError, "Missing the required parameter 'save_lease' when calling LeasesApi.create_lease"
  end
  # resource path
  local_var_path = '/leases'

  # 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(save_lease)

  # return_type
  return_type = opts[:debug_return_type] || 'Lease'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.create_lease",
    :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: LeasesApi#create_lease\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_lease(lease_id, opts = {}) ⇒ ResponseEntity

Delete a lease (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Deletes a lease<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Delete

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:



725
726
727
728
 
# File 'lib/propertyware/api/leases_api.rb', line 725

def delete_lease(lease_id, opts = {})
  data, _status_code, _headers = delete_lease_with_http_info(lease_id, opts)
  data
end

#delete_lease_conversation(lease_id, conversation_id, opts = {}) ⇒ ResponseEntity

Delete a lease conversation (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Deletes a specific lease conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Delete

Parameters:

  • lease_id (Integer) —

    Lease ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:



789
790
791
792
 
# File 'lib/propertyware/api/leases_api.rb', line 789

def delete_lease_conversation(lease_id, conversation_id, opts = {})
  data, _status_code, _headers = delete_lease_conversation_with_http_info(lease_id, conversation_id, opts)
  data
end

#delete_lease_conversation_with_http_info(lease_id, conversation_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>

Delete a lease conversation (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Deletes a specific lease conversation.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:

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

    ResponseEntity data, response status code and response headers



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/propertyware/api/leases_api.rb', line 800

def delete_lease_conversation_with_http_info(lease_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.delete_lease_conversation ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.delete_lease_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling LeasesApi.delete_lease_conversation"
  end
  # resource path
  local_var_path = '/leases/{leaseID}/conversations/{conversationID}'.sub('{' + 'leaseID' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'conversationID' + '}', CGI.escape(conversation_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] || 'ResponseEntity'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.delete_lease_conversation",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LeasesApi#delete_lease_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_lease_with_http_info(lease_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>

Delete a lease (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Deletes a lease&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:

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

    ResponseEntity data, response status code and response headers



735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/propertyware/api/leases_api.rb', line 735

def delete_lease_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.delete_lease ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.delete_lease"
  end
  # resource path
  local_var_path = '/leases/{leaseID}'.sub('{' + 'leaseID' + '}', CGI.escape(lease_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(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ResponseEntity'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.delete_lease",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LeasesApi#delete_lease\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_lease_statuses(opts = {}) ⇒ Array<LeaseStatus>

Retrieve all lease statuses (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of all lease statuses<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

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

    the optional parameters

Returns:



856
857
858
859
 
# File 'lib/propertyware/api/leases_api.rb', line 856

def get_all_lease_statuses(opts = {})
  data, _status_code, _headers = get_all_lease_statuses_with_http_info(opts)
  data
end

#get_all_lease_statuses_with_http_info(opts = {}) ⇒ Array<(Array<LeaseStatus>, Integer, Hash)>

Retrieve all lease statuses (BETA) &lt;p class&#x3D;&quot;betaWarning&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a list of all lease statuses&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

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

    the optional parameters

Returns:

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

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



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
 
# File 'lib/propertyware/api/leases_api.rb', line 865

def get_all_lease_statuses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_all_lease_statuses ...'
  end
  # resource path
  local_var_path = '/leases/statuses'

  # 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] || 'Array<LeaseStatus>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_all_lease_statuses",
    :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: LeasesApi#get_all_lease_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease(lease_id, opts = {}) ⇒ Lease

Retrieve a lease Retrieves a specific lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Options Hash (opts):

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to true)

Returns:



915
916
917
918
 
# File 'lib/propertyware/api/leases_api.rb', line 915

def get_lease(lease_id, opts = {})
  data, _status_code, _headers = get_lease_with_http_info(lease_id, opts)
  data
end

#get_lease_adjustments(opts = {}) ⇒ Array<Adjustment>

Retrieve all the adjustments Retrieves a list of adjustments.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read <br/><br/>Sortable by: leaseid, postdate, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:



989
990
991
992
 
# File 'lib/propertyware/api/leases_api.rb', line 989

def get_lease_adjustments(opts = {})
  data, _status_code, _headers = get_lease_adjustments_with_http_info(opts)
  data
end

#get_lease_adjustments_with_http_info(opts = {}) ⇒ Array<(Array<Adjustment>, Integer, Hash)>

Retrieve all the adjustments Retrieves a list of adjustments.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;leaseid&lt;/code&gt;, &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:

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

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



1008
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
1059
1060
 
# File 'lib/propertyware/api/leases_api.rb', line 1008

def get_lease_adjustments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_adjustments ...'
  end
  # resource path
  local_var_path = '/leases/adjustments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'leaseID'] = opts[:'lease_id'] if !opts[:'lease_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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<Adjustment>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_adjustments",
    :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: LeasesApi#get_lease_adjustments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_auto_charges(lease_id, opts = {}) ⇒ Array<Charge>

Retrieve all lease auto charges Retrieves all the auto charges of a lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:



1067
1068
1069
1070
 
# File 'lib/propertyware/api/leases_api.rb', line 1067

def get_lease_auto_charges(lease_id, opts = {})
  data, _status_code, _headers = get_lease_auto_charges_with_http_info(lease_id, opts)
  data
end

#get_lease_auto_charges_with_http_info(lease_id, opts = {}) ⇒ Array<(Array<Charge>, Integer, Hash)>

Retrieve all lease auto charges Retrieves all the auto charges of a lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:

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

    Array<Charge> 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
 
# File 'lib/propertyware/api/leases_api.rb', line 1077

def get_lease_auto_charges_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_auto_charges ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_auto_charges"
  end
  # resource path
  local_var_path = '/leases/{leaseId}/autocharges'.sub('{' + 'leaseId' + '}', CGI.escape(lease_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] || 'Array<Charge>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_auto_charges",
    :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: LeasesApi#get_lease_auto_charges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_auto_e_payments(lease_id, opts = {}) ⇒ AutoPayment

Retrieve all lease auto ePayments (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves all the auto ePayments of a lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:



1130
1131
1132
1133
 
# File 'lib/propertyware/api/leases_api.rb', line 1130

def get_lease_auto_e_payments(lease_id, opts = {})
  data, _status_code, _headers = get_lease_auto_e_payments_with_http_info(lease_id, opts)
  data
end

#get_lease_auto_e_payments_with_http_info(lease_id, opts = {}) ⇒ Array<(AutoPayment, Integer, Hash)>

Retrieve all lease auto ePayments (BETA) &lt;p class&#x3D;&quot;betaWarning&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves all the auto ePayments of a lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:

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

    AutoPayment data, response status code and response headers



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
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
 
# File 'lib/propertyware/api/leases_api.rb', line 1140

def get_lease_auto_e_payments_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_auto_e_payments ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_auto_e_payments"
  end
  # resource path
  local_var_path = '/leases/{leaseId}/autoepayments'.sub('{' + 'leaseId' + '}', CGI.escape(lease_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] || 'AutoPayment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_auto_e_payments",
    :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: LeasesApi#get_lease_auto_e_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_auto_journal_entries(lease_id, opts = {}) ⇒ AutoJournalEntry

Retrieve all lease auto journal entries (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves all the auto journal entries of a lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:



1193
1194
1195
1196
 
# File 'lib/propertyware/api/leases_api.rb', line 1193

def get_lease_auto_journal_entries(lease_id, opts = {})
  data, _status_code, _headers = get_lease_auto_journal_entries_with_http_info(lease_id, opts)
  data
end

#get_lease_auto_journal_entries_with_http_info(lease_id, opts = {}) ⇒ Array<(AutoJournalEntry, Integer, Hash)>

Retrieve all lease auto journal entries (BETA) &lt;p class&#x3D;&quot;betaWarning&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves all the auto journal entries of a lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:

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

    AutoJournalEntry data, response status code and response headers



1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/propertyware/api/leases_api.rb', line 1203

def get_lease_auto_journal_entries_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_auto_journal_entries ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_auto_journal_entries"
  end
  # resource path
  local_var_path = '/leases/{leaseId}/autojournalentries'.sub('{' + 'leaseId' + '}', CGI.escape(lease_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] || 'AutoJournalEntry'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_auto_journal_entries",
    :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: LeasesApi#get_lease_auto_journal_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_charges(opts = {}) ⇒ Array<ChargeTx>

Retrieve all the lease charges Retrieves a list of lease charges.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read <br/><br/>Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:



1265
1266
1267
1268
 
# File 'lib/propertyware/api/leases_api.rb', line 1265

def get_lease_charges(opts = {})
  data, _status_code, _headers = get_lease_charges_with_http_info(opts)
  data
end

#get_lease_charges_with_http_info(opts = {}) ⇒ Array<(Array<ChargeTx>, Integer, Hash)>

Retrieve all the lease charges Retrieves a list of lease charges.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;leaseid&lt;/code&gt;, &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:

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

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



1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
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
 
# File 'lib/propertyware/api/leases_api.rb', line 1284

def get_lease_charges_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_charges ...'
  end
  # resource path
  local_var_path = '/leases/charges'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'leaseID'] = opts[:'lease_id'] if !opts[:'lease_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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<ChargeTx>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_charges",
    :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: LeasesApi#get_lease_charges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_contacts(lease_id, opts = {}) ⇒ Array<Contact>

Retrieve all lease contacts Retrieves all the contacts of a lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Options Hash (opts):

  • :include_contact_custom_fields_in_the_response_ (Boolean) —

    Include contact custom fields in the response.

Returns:



1344
1345
1346
1347
 
# File 'lib/propertyware/api/leases_api.rb', line 1344

def get_lease_contacts(lease_id, opts = {})
  data, _status_code, _headers = get_lease_contacts_with_http_info(lease_id, opts)
  data
end

#get_lease_contacts_with_http_info(lease_id, opts = {}) ⇒ Array<(Array<Contact>, Integer, Hash)>

Retrieve all lease contacts Retrieves all the contacts of a lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Options Hash (opts):

  • :include_contact_custom_fields_in_the_response_ (Boolean) —

    Include contact custom fields in the response.

Returns:

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

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



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'lib/propertyware/api/leases_api.rb', line 1355

def get_lease_contacts_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_contacts ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_contacts"
  end
  # resource path
  local_var_path = '/leases/{leaseId}/contacts'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'Include contact custom fields in the response.'] = opts[:'include_contact_custom_fields_in_the_response_'] if !opts[:'include_contact_custom_fields_in_the_response_'].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<Contact>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_contacts",
    :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: LeasesApi#get_lease_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_conversation(lease_id, conversation_id, opts = {}) ⇒ Conversation

Retrieve a lease conversation Retrieves a specific lease conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:



1410
1411
1412
1413
 
# File 'lib/propertyware/api/leases_api.rb', line 1410

def get_lease_conversation(lease_id, conversation_id, opts = {})
  data, _status_code, _headers = get_lease_conversation_with_http_info(lease_id, conversation_id, opts)
  data
end

#get_lease_conversation_with_http_info(lease_id, conversation_id, opts = {}) ⇒ Array<(Conversation, Integer, Hash)>

Retrieve a lease conversation Retrieves a specific lease conversation.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/propertyware/api/leases_api.rb', line 1421

def get_lease_conversation_with_http_info(lease_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_conversation ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling LeasesApi.get_lease_conversation"
  end
  # resource path
  local_var_path = '/leases/{leaseID}/conversations/{conversationID}'.sub('{' + 'leaseID' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'conversationID' + '}', CGI.escape(conversation_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] || 'Conversation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_conversation",
    :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: LeasesApi#get_lease_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_conversations(lease_id, opts = {}) ⇒ Array<Conversation>

Retrieve all lease conversations Retrieves all the conversations of a lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read <br/><br/>Sortable by: createddate, lastmodifieddatetime, id

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :type (String) —

    Filters results by the conversation type.

Returns:



1484
1485
1486
1487
 
# File 'lib/propertyware/api/leases_api.rb', line 1484

def get_lease_conversations(lease_id, opts = {})
  data, _status_code, _headers = get_lease_conversations_with_http_info(lease_id, opts)
  data
end

#get_lease_conversations_with_http_info(lease_id, opts = {}) ⇒ Array<(Array<Conversation>, Integer, Hash)>

Retrieve all lease conversations Retrieves all the conversations of a lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :type (String) —

    Filters results by the conversation type.

Returns:

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

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



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
 
# File 'lib/propertyware/api/leases_api.rb', line 1500

def get_lease_conversations_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_conversations ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_conversations"
  end
  allowable_values = ["MANAGEMENT_TEAM", "OWNER", "TENANT"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/leases/{leaseID}/conversations'.sub('{' + 'leaseID' + '}', CGI.escape(lease_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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<Conversation>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_conversations",
    :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: LeasesApi#get_lease_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_credit_memos(opts = {}) ⇒ Array<CreditMemo>

Retrieve all the credit memos Retrieves a list of credit memos.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read <br/><br/>Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:



1572
1573
1574
1575
 
# File 'lib/propertyware/api/leases_api.rb', line 1572

def get_lease_credit_memos(opts = {})
  data, _status_code, _headers = get_lease_credit_memos_with_http_info(opts)
  data
end

#get_lease_credit_memos_with_http_info(opts = {}) ⇒ Array<(Array<CreditMemo>, Integer, Hash)>

Retrieve all the credit memos Retrieves a list of credit memos.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;leaseid&lt;/code&gt;, &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:

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

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



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
 
# File 'lib/propertyware/api/leases_api.rb', line 1591

def get_lease_credit_memos_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_credit_memos ...'
  end
  # resource path
  local_var_path = '/leases/creditmemos'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'leaseID'] = opts[:'lease_id'] if !opts[:'lease_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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<CreditMemo>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_credit_memos",
    :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: LeasesApi#get_lease_credit_memos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_custom_fields(lease_id, opts = {}) ⇒ Array<CustomField>

Retrieve all lease custom fields Retrieves all the custom fields of a lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:



1650
1651
1652
1653
 
# File 'lib/propertyware/api/leases_api.rb', line 1650

def get_lease_custom_fields(lease_id, opts = {})
  data, _status_code, _headers = get_lease_custom_fields_with_http_info(lease_id, opts)
  data
end

#get_lease_custom_fields_with_http_info(lease_id, opts = {}) ⇒ Array<(Array<CustomField>, Integer, Hash)>

Retrieve all lease custom fields Retrieves all the custom fields of a lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:

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

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



1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
 
# File 'lib/propertyware/api/leases_api.rb', line 1660

def get_lease_custom_fields_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_custom_fields ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_custom_fields"
  end
  # resource path
  local_var_path = '/leases/{leaseId}/customfields'.sub('{' + 'leaseId' + '}', CGI.escape(lease_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] || 'Array<CustomField>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_custom_fields",
    :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: LeasesApi#get_lease_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_discounts(opts = {}) ⇒ Array<Discount>

Retrieve all the lease discounts Retrieves a list of lease discounts<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read <br/><br/>Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :lease_id (Integer) —

    Filters results to any LeaseID.

  • :post_date_start (Date) —

    Filters results to any discount with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any discount with a start date on or prior to the date specified.

Returns:



1720
1721
1722
1723
 
# File 'lib/propertyware/api/leases_api.rb', line 1720

def get_lease_discounts(opts = {})
  data, _status_code, _headers = get_lease_discounts_with_http_info(opts)
  data
end

#get_lease_discounts_with_http_info(opts = {}) ⇒ Array<(Array<Discount>, Integer, Hash)>

Retrieve all the lease discounts Retrieves a list of lease discounts&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;leaseid&lt;/code&gt;, &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :lease_id (Integer) —

    Filters results to any LeaseID.

  • :post_date_start (Date) —

    Filters results to any discount with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any discount with a start date on or prior to the date specified.

Returns:

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

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



1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
 
# File 'lib/propertyware/api/leases_api.rb', line 1737

def get_lease_discounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_discounts ...'
  end
  # resource path
  local_var_path = '/leases/discounts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'leaseID'] = opts[:'lease_id'] if !opts[:'lease_id'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].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<Discount>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_discounts",
    :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: LeasesApi#get_lease_discounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_documents(lease_id, opts = {}) ⇒ Array<Document>

Retrieve all lease documents Retrieves all the documents of a lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:



1794
1795
1796
1797
 
# File 'lib/propertyware/api/leases_api.rb', line 1794

def get_lease_documents(lease_id, opts = {})
  data, _status_code, _headers = get_lease_documents_with_http_info(lease_id, opts)
  data
end

#get_lease_documents_with_http_info(lease_id, opts = {}) ⇒ Array<(Array<Document>, Integer, Hash)>

Retrieve all lease documents Retrieves all the documents of a lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:

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

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



1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
 
# File 'lib/propertyware/api/leases_api.rb', line 1804

def get_lease_documents_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_documents ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_documents"
  end
  # resource path
  local_var_path = '/leases/{leaseId}/document'.sub('{' + 'leaseId' + '}', CGI.escape(lease_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] || 'Array<Document>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_documents",
    :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: LeasesApi#get_lease_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_journal_entry(lease_id, opts = {}) ⇒ JournalEntry

Retrieve all lease journal entries Retrieves a specific lease journal entries.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :lease_id2 (Integer) —

    Filters results to transactions associated with a specific lease.

  • :post_date_start (Date) —

    Filters results to any transaction with post date on or after to the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with post date on or prior to the date specified.

Returns:



1865
1866
1867
1868
 
# File 'lib/propertyware/api/leases_api.rb', line 1865

def get_lease_journal_entry(lease_id, opts = {})
  data, _status_code, _headers = get_lease_journal_entry_with_http_info(lease_id, opts)
  data
end

#get_lease_journal_entry_with_http_info(lease_id, opts = {}) ⇒ Array<(JournalEntry, Integer, Hash)>

Retrieve all lease journal entries Retrieves a specific lease journal entries.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :lease_id2 (Integer) —

    Filters results to transactions associated with a specific lease.

  • :post_date_start (Date) —

    Filters results to any transaction with post date on or after to the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with post date on or prior to the date specified.

Returns:

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

    JournalEntry data, response status code and response headers



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
 
# File 'lib/propertyware/api/leases_api.rb', line 1883

def get_lease_journal_entry_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_journal_entry ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_journal_entry"
  end
  # resource path
  local_var_path = '/leases/journalentries/{leaseID}'.sub('{' + 'leaseID' + '}', CGI.escape(lease_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'leaseID'] = opts[:'lease_id2'] if !opts[:'lease_id2'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].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] || 'JournalEntry'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_journal_entry",
    :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: LeasesApi#get_lease_journal_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_late_fee(lease_id, opts = {}) ⇒ LateFeeRule

Retrieve the lease late fee rule Retrieves the lease late fee rule.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:



1944
1945
1946
1947
 
# File 'lib/propertyware/api/leases_api.rb', line 1944

def get_lease_late_fee(lease_id, opts = {})
  data, _status_code, _headers = get_lease_late_fee_with_http_info(lease_id, opts)
  data
end

#get_lease_late_fee_with_http_info(lease_id, opts = {}) ⇒ Array<(LateFeeRule, Integer, Hash)>

Retrieve the lease late fee rule Retrieves the lease late fee rule.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:

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

    LateFeeRule data, response status code and response headers



1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
 
# File 'lib/propertyware/api/leases_api.rb', line 1954

def get_lease_late_fee_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_late_fee ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_late_fee"
  end
  # resource path
  local_var_path = '/leases/{leaseId}/latefeerule'.sub('{' + 'leaseId' + '}', CGI.escape(lease_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] || 'LateFeeRule'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_late_fee",
    :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: LeasesApi#get_lease_late_fee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_notes(lease_id, opts = {}) ⇒ Array<Note>

Retrieve all lease notes Retrieves all the notes of a lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:



2007
2008
2009
2010
 
# File 'lib/propertyware/api/leases_api.rb', line 2007

def get_lease_notes(lease_id, opts = {})
  data, _status_code, _headers = get_lease_notes_with_http_info(lease_id, opts)
  data
end

#get_lease_notes_with_http_info(lease_id, opts = {}) ⇒ Array<(Array<Note>, Integer, Hash)>

Retrieve all lease notes Retrieves all the notes of a lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:

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

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



2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
 
# File 'lib/propertyware/api/leases_api.rb', line 2017

def get_lease_notes_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_notes ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_notes"
  end
  # resource path
  local_var_path = '/leases/{leaseId}/notes'.sub('{' + 'leaseId' + '}', CGI.escape(lease_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] || 'Array<Note>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_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: LeasesApi#get_lease_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_payments(opts = {}) ⇒ Array<Payment>

Retrieve all the lease payments Retrieves a list of lease payments.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read <br/><br/>Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:



2079
2080
2081
2082
 
# File 'lib/propertyware/api/leases_api.rb', line 2079

def get_lease_payments(opts = {})
  data, _status_code, _headers = get_lease_payments_with_http_info(opts)
  data
end

#get_lease_payments_with_http_info(opts = {}) ⇒ Array<(Array<Payment>, Integer, Hash)>

Retrieve all the lease payments Retrieves a list of lease payments.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;leaseid&lt;/code&gt;, &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:

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

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



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/propertyware/api/leases_api.rb', line 2098

def get_lease_payments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_payments ...'
  end
  # resource path
  local_var_path = '/leases/payments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'leaseID'] = opts[:'lease_id'] if !opts[:'lease_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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<Payment>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_payments",
    :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: LeasesApi#get_lease_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_refunds(opts = {}) ⇒ Array<Refund>

Retrieve all the tenant refunds Retrieves a list of tenant refunds.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read <br/><br/>Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:



2166
2167
2168
2169
 
# File 'lib/propertyware/api/leases_api.rb', line 2166

def get_lease_refunds(opts = {})
  data, _status_code, _headers = get_lease_refunds_with_http_info(opts)
  data
end

#get_lease_refunds_with_http_info(opts = {}) ⇒ Array<(Array<Refund>, Integer, Hash)>

Retrieve all the tenant refunds Retrieves a list of tenant refunds.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;leaseid&lt;/code&gt;, &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:

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

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



2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
 
# File 'lib/propertyware/api/leases_api.rb', line 2185

def get_lease_refunds_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_refunds ...'
  end
  # resource path
  local_var_path = '/leases/refunds'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'leaseID'] = opts[:'lease_id'] if !opts[:'lease_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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<Refund>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_refunds",
    :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: LeasesApi#get_lease_refunds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_with_http_info(lease_id, opts = {}) ⇒ Array<(Lease, Integer, Hash)>

Retrieve a lease Retrieves a specific lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Options Hash (opts):

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to true)

Returns:

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

    Lease data, response status code and response headers



926
927
928
929
930
931
932
933
934
935
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
 
# File 'lib/propertyware/api/leases_api.rb', line 926

def get_lease_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease"
  end
  # resource path
  local_var_path = '/leases/{leaseId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'includeCustomFields'] = opts[:'include_custom_fields'] if !opts[:'include_custom_fields'].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] || 'Lease'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease",
    :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: LeasesApi#get_lease\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lease_work_orders(lease_id, opts = {}) ⇒ Array<WorkOrder>

Retrieve all lease work orders Retrieves all the work orders of a lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:



2244
2245
2246
2247
 
# File 'lib/propertyware/api/leases_api.rb', line 2244

def get_lease_work_orders(lease_id, opts = {})
  data, _status_code, _headers = get_lease_work_orders_with_http_info(lease_id, opts)
  data
end

#get_lease_work_orders_with_http_info(lease_id, opts = {}) ⇒ Array<(Array<WorkOrder>, Integer, Hash)>

Retrieve all lease work orders Retrieves all the work orders of a lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

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

    the optional parameters

Returns:

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

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



2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
 
# File 'lib/propertyware/api/leases_api.rb', line 2254

def get_lease_work_orders_with_http_info(lease_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_work_orders ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_work_orders"
  end
  # resource path
  local_var_path = '/leases/{leaseId}/workorders'.sub('{' + 'leaseId' + '}', CGI.escape(lease_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] || 'Array<WorkOrder>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_lease_work_orders",
    :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: LeasesApi#get_lease_work_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_leases(opts = {}) ⇒ Array<Lease>

Retrieve all leases Retrieves a list of leases.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Read <br/><br/>Sortable by: startdate, idnumber, scheduledmoveoutdate, enddate, lastmodifieddatetime, status, moveoutdate, id, moveindate

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :start_date_start (Date) —

    Filters results to any lease with a start date on or after the date specified.

  • :start_date_end (Date) —

    Filters results to any lease with a start date on or prior to the date specified.

  • :end_date_start (Date) —

    Filters results to any lease with a end date on or after the date specified.

  • :end_date_end (Date) —

    Filters results to any lease with a end date on or prior to the date specified.

  • :move_in_date_start (Date) —

    Filters results to any lease with a move-in date on or after the date specified.

  • :move_in_date_end (Date) —

    Filters results to any lease with a move-in date on or prior to the date specified.

  • :schedule_move_out_date_start (Date) —

    Filters results to any lease with a move-out date on or after the date specified.

  • :schedule_move_out_date_end (Date) —

    Filters results to any lease with a move-out date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results to leases associated with a specific portfolio.

  • :building_id (Integer) —

    Filters results to leases associated with a specific building.

  • :unit_id (Integer) —

    Filters results to leases associated with a specific unit.

  • :status (String) —

    Filters results to inspections with a specific status.

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to false)

Returns:



2324
2325
2326
2327
 
# File 'lib/propertyware/api/leases_api.rb', line 2324

def get_leases(opts = {})
  data, _status_code, _headers = get_leases_with_http_info(opts)
  data
end

#get_leases_with_http_info(opts = {}) ⇒ Array<(Array<Lease>, Integer, Hash)>

Retrieve all leases Retrieves a list of leases.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;startdate&lt;/code&gt;, &lt;code&gt;idnumber&lt;/code&gt;, &lt;code&gt;scheduledmoveoutdate&lt;/code&gt;, &lt;code&gt;enddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;status&lt;/code&gt;, &lt;code&gt;moveoutdate&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;, &lt;code&gt;moveindate&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :start_date_start (Date) —

    Filters results to any lease with a start date on or after the date specified.

  • :start_date_end (Date) —

    Filters results to any lease with a start date on or prior to the date specified.

  • :end_date_start (Date) —

    Filters results to any lease with a end date on or after the date specified.

  • :end_date_end (Date) —

    Filters results to any lease with a end date on or prior to the date specified.

  • :move_in_date_start (Date) —

    Filters results to any lease with a move-in date on or after the date specified.

  • :move_in_date_end (Date) —

    Filters results to any lease with a move-in date on or prior to the date specified.

  • :schedule_move_out_date_start (Date) —

    Filters results to any lease with a move-out date on or after the date specified.

  • :schedule_move_out_date_end (Date) —

    Filters results to any lease with a move-out date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results to leases associated with a specific portfolio.

  • :building_id (Integer) —

    Filters results to leases associated with a specific building.

  • :unit_id (Integer) —

    Filters results to leases associated with a specific unit.

  • :status (String) —

    Filters results to inspections with a specific status.

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to false)

Returns:

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

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



2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
 
# File 'lib/propertyware/api/leases_api.rb', line 2351

def get_leases_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.get_leases ...'
  end
  # resource path
  local_var_path = '/leases'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'startDateStart'] = opts[:'start_date_start'] if !opts[:'start_date_start'].nil?
  query_params[:'startDateEnd'] = opts[:'start_date_end'] if !opts[:'start_date_end'].nil?
  query_params[:'endDateStart'] = opts[:'end_date_start'] if !opts[:'end_date_start'].nil?
  query_params[:'endDateEnd'] = opts[:'end_date_end'] if !opts[:'end_date_end'].nil?
  query_params[:'moveInDateStart'] = opts[:'move_in_date_start'] if !opts[:'move_in_date_start'].nil?
  query_params[:'moveInDateEnd'] = opts[:'move_in_date_end'] if !opts[:'move_in_date_end'].nil?
  query_params[:'scheduleMoveOutDateStart'] = opts[:'schedule_move_out_date_start'] if !opts[:'schedule_move_out_date_start'].nil?
  query_params[:'scheduleMoveOutDateEnd'] = opts[:'schedule_move_out_date_end'] if !opts[:'schedule_move_out_date_end'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'buildingID'] = opts[:'building_id'] if !opts[:'building_id'].nil?
  query_params[:'unitID'] = opts[:'unit_id'] if !opts[:'unit_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'includeCustomFields'] = opts[:'include_custom_fields'] if !opts[:'include_custom_fields'].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<Lease>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.get_leases",
    :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: LeasesApi#get_leases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_lease(lease_id, save_lease, opts = {}) ⇒ Lease

Update a lease (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Updates an existing lease.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • lease_id (Integer) —

    Lease ID

  • save_lease (SaveLease) —

    lease

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

    the optional parameters

Returns:



2419
2420
2421
2422
 
# File 'lib/propertyware/api/leases_api.rb', line 2419

def update_lease(lease_id, save_lease, opts = {})
  data, _status_code, _headers = update_lease_with_http_info(lease_id, save_lease, opts)
  data
end

#update_lease_adjustment(adjustment_id, save_adjustment, opts = {}) ⇒ Adjustment

Update a lease adjustment (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Updates an lease adjustment.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • adjustment_id (Integer) —

    Adjustment ID

  • save_adjustment (SaveAdjustment) —

    saveAdjustment

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

    the optional parameters

Returns:



2493
2494
2495
2496
 
# File 'lib/propertyware/api/leases_api.rb', line 2493

def update_lease_adjustment(adjustment_id, save_adjustment, opts = {})
  data, _status_code, _headers = update_lease_adjustment_with_http_info(adjustment_id, save_adjustment, opts)
  data
end

#update_lease_adjustment_with_http_info(adjustment_id, save_adjustment, opts = {}) ⇒ Array<(Adjustment, Integer, Hash)>

Update a lease adjustment (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Updates an lease adjustment.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • adjustment_id (Integer) —

    Adjustment ID

  • save_adjustment (SaveAdjustment) —

    saveAdjustment

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

    the optional parameters

Returns:

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

    Adjustment data, response status code and response headers



2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
 
# File 'lib/propertyware/api/leases_api.rb', line 2504

def update_lease_adjustment_with_http_info(adjustment_id, save_adjustment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease_adjustment ...'
  end
  # verify the required parameter 'adjustment_id' is set
  if @api_client.config.client_side_validation && adjustment_id.nil?
    fail ArgumentError, "Missing the required parameter 'adjustment_id' when calling LeasesApi.update_lease_adjustment"
  end
  # verify the required parameter 'save_adjustment' is set
  if @api_client.config.client_side_validation && save_adjustment.nil?
    fail ArgumentError, "Missing the required parameter 'save_adjustment' when calling LeasesApi.update_lease_adjustment"
  end
  # resource path
  local_var_path = '/leases/adjustments/{adjustmentID}'.sub('{' + 'adjustmentID' + '}', CGI.escape(adjustment_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(save_adjustment)

  # return_type
  return_type = opts[:debug_return_type] || 'Adjustment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.update_lease_adjustment",
    :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: LeasesApi#update_lease_adjustment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_lease_charge(charge_id, save_charge, opts = {}) ⇒ ChargeTx

Update a lease charge (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Updates a lease charge.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • charge_id (Integer) —

    Charge ID

  • save_charge (SaveCharge) —

    saveCharge

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

    the optional parameters

Returns:



2567
2568
2569
2570
 
# File 'lib/propertyware/api/leases_api.rb', line 2567

def update_lease_charge(charge_id, save_charge, opts = {})
  data, _status_code, _headers = update_lease_charge_with_http_info(charge_id, save_charge, opts)
  data
end

#update_lease_charge_with_http_info(charge_id, save_charge, opts = {}) ⇒ Array<(ChargeTx, Integer, Hash)>

Update a lease charge (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Updates a lease charge.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • charge_id (Integer) —

    Charge ID

  • save_charge (SaveCharge) —

    saveCharge

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

    the optional parameters

Returns:

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

    ChargeTx data, response status code and response headers



2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
 
# File 'lib/propertyware/api/leases_api.rb', line 2578

def update_lease_charge_with_http_info(charge_id, save_charge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease_charge ...'
  end
  # verify the required parameter 'charge_id' is set
  if @api_client.config.client_side_validation && charge_id.nil?
    fail ArgumentError, "Missing the required parameter 'charge_id' when calling LeasesApi.update_lease_charge"
  end
  # verify the required parameter 'save_charge' is set
  if @api_client.config.client_side_validation && save_charge.nil?
    fail ArgumentError, "Missing the required parameter 'save_charge' when calling LeasesApi.update_lease_charge"
  end
  # resource path
  local_var_path = '/leases/charges/{chargeID}'.sub('{' + 'chargeID' + '}', CGI.escape(charge_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(save_charge)

  # return_type
  return_type = opts[:debug_return_type] || 'ChargeTx'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.update_lease_charge",
    :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: LeasesApi#update_lease_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_lease_discount(discount_id, save_discount, opts = {}) ⇒ Discount

Updates a lease Discount (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Updates a lease Discount.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • discount_id (Integer) —

    Discount ID

  • save_discount (SaveDiscount) —

    saveDiscount

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

    the optional parameters

Returns:



2641
2642
2643
2644
 
# File 'lib/propertyware/api/leases_api.rb', line 2641

def update_lease_discount(discount_id, save_discount, opts = {})
  data, _status_code, _headers = update_lease_discount_with_http_info(discount_id, save_discount, opts)
  data
end

#update_lease_discount_with_http_info(discount_id, save_discount, opts = {}) ⇒ Array<(Discount, Integer, Hash)>

Updates a lease Discount (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Updates a lease Discount.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • discount_id (Integer) —

    Discount ID

  • save_discount (SaveDiscount) —

    saveDiscount

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

    the optional parameters

Returns:

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

    Discount data, response status code and response headers



2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
 
# File 'lib/propertyware/api/leases_api.rb', line 2652

def update_lease_discount_with_http_info(discount_id, save_discount, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease_discount ...'
  end
  # verify the required parameter 'discount_id' is set
  if @api_client.config.client_side_validation && discount_id.nil?
    fail ArgumentError, "Missing the required parameter 'discount_id' when calling LeasesApi.update_lease_discount"
  end
  # verify the required parameter 'save_discount' is set
  if @api_client.config.client_side_validation && save_discount.nil?
    fail ArgumentError, "Missing the required parameter 'save_discount' when calling LeasesApi.update_lease_discount"
  end
  # resource path
  local_var_path = '/leases/discounts/{discountID}'.sub('{' + 'discountID' + '}', CGI.escape(discount_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(save_discount)

  # return_type
  return_type = opts[:debug_return_type] || 'Discount'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.update_lease_discount",
    :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: LeasesApi#update_lease_discount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_lease_journal_entry(journalentry_id, update_lease_journal_entry, opts = {}) ⇒ JournalEntry

Update a lease journal entry (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Updates a lease journal entry.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write <br/><br/>Sortable by: postdate, createddate, lastmodifieddatetime, id

Parameters:

  • journalentry_id (Integer) —

    Journal Entry ID

  • update_lease_journal_entry (UpdateLeaseJournalEntry) —

    updateLeaseJournalEntry

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

    the optional parameters

Returns:



2715
2716
2717
2718
 
# File 'lib/propertyware/api/leases_api.rb', line 2715

def update_lease_journal_entry(journalentry_id, update_lease_journal_entry, opts = {})
  data, _status_code, _headers = update_lease_journal_entry_with_http_info(journalentry_id, update_lease_journal_entry, opts)
  data
end

#update_lease_journal_entry_with_http_info(journalentry_id, update_lease_journal_entry, opts = {}) ⇒ Array<(JournalEntry, Integer, Hash)>

Update a lease journal entry (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Updates a lease journal entry.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

  • journalentry_id (Integer) —

    Journal Entry ID

  • update_lease_journal_entry (UpdateLeaseJournalEntry) —

    updateLeaseJournalEntry

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

    the optional parameters

Returns:

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

    JournalEntry data, response status code and response headers



2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'lib/propertyware/api/leases_api.rb', line 2726

def update_lease_journal_entry_with_http_info(journalentry_id, update_lease_journal_entry, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease_journal_entry ...'
  end
  # verify the required parameter 'journalentry_id' is set
  if @api_client.config.client_side_validation && journalentry_id.nil?
    fail ArgumentError, "Missing the required parameter 'journalentry_id' when calling LeasesApi.update_lease_journal_entry"
  end
  # verify the required parameter 'update_lease_journal_entry' is set
  if @api_client.config.client_side_validation && update_lease_journal_entry.nil?
    fail ArgumentError, "Missing the required parameter 'update_lease_journal_entry' when calling LeasesApi.update_lease_journal_entry"
  end
  # resource path
  local_var_path = '/leases/journalentries/{journalentryID}'.sub('{' + 'journalentryID' + '}', CGI.escape(journalentry_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_lease_journal_entry)

  # return_type
  return_type = opts[:debug_return_type] || 'JournalEntry'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.update_lease_journal_entry",
    :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: LeasesApi#update_lease_journal_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_lease_payment(entity_id, save_payment, opts = {}) ⇒ Payment

Update a lease payment (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Updates a lease payment.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • entity_id (Integer) —

    Lease Payment ID

  • save_payment (SavePayment) —

    savePayment

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

    the optional parameters

Returns:



2789
2790
2791
2792
 
# File 'lib/propertyware/api/leases_api.rb', line 2789

def update_lease_payment(entity_id, save_payment, opts = {})
  data, _status_code, _headers = update_lease_payment_with_http_info(entity_id, save_payment, opts)
  data
end

#update_lease_payment_with_http_info(entity_id, save_payment, opts = {}) ⇒ Array<(Payment, Integer, Hash)>

Update a lease payment (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Updates a lease payment.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • entity_id (Integer) —

    Lease Payment ID

  • save_payment (SavePayment) —

    savePayment

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
 
# File 'lib/propertyware/api/leases_api.rb', line 2800

def update_lease_payment_with_http_info(entity_id, save_payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease_payment ...'
  end
  # verify the required parameter 'entity_id' is set
  if @api_client.config.client_side_validation && entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_id' when calling LeasesApi.update_lease_payment"
  end
  # verify the required parameter 'save_payment' is set
  if @api_client.config.client_side_validation && save_payment.nil?
    fail ArgumentError, "Missing the required parameter 'save_payment' when calling LeasesApi.update_lease_payment"
  end
  # resource path
  local_var_path = '/leases/payments/{entityID}'.sub('{' + 'entityID' + '}', CGI.escape(entity_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(save_payment)

  # return_type
  return_type = opts[:debug_return_type] || 'Payment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.update_lease_payment",
    :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: LeasesApi#update_lease_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_lease_refund(refund_id, save_refund, opts = {}) ⇒ Refund

Update a lease refund (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Update an lease refund.<br/><br/>Required permission:<br/><span class="permissionBlock">LEASES</span> - Write

Parameters:

  • refund_id (Integer) —

    Refund ID

  • save_refund (SaveRefund) —

    saveRefund

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

    the optional parameters

Returns:



2863
2864
2865
2866
 
# File 'lib/propertyware/api/leases_api.rb', line 2863

def update_lease_refund(refund_id, save_refund, opts = {})
  data, _status_code, _headers = update_lease_refund_with_http_info(refund_id, save_refund, opts)
  data
end

#update_lease_refund_with_http_info(refund_id, save_refund, opts = {}) ⇒ Array<(Refund, Integer, Hash)>

Update a lease refund (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Update an lease refund.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • refund_id (Integer) —

    Refund ID

  • save_refund (SaveRefund) —

    saveRefund

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

    the optional parameters

Returns:

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

    Refund data, response status code and response headers



2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
 
# File 'lib/propertyware/api/leases_api.rb', line 2874

def update_lease_refund_with_http_info(refund_id, save_refund, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease_refund ...'
  end
  # verify the required parameter 'refund_id' is set
  if @api_client.config.client_side_validation && refund_id.nil?
    fail ArgumentError, "Missing the required parameter 'refund_id' when calling LeasesApi.update_lease_refund"
  end
  # verify the required parameter 'save_refund' is set
  if @api_client.config.client_side_validation && save_refund.nil?
    fail ArgumentError, "Missing the required parameter 'save_refund' when calling LeasesApi.update_lease_refund"
  end
  # resource path
  local_var_path = '/leases/refunds/{refundID}'.sub('{' + 'refundID' + '}', CGI.escape(refund_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(save_refund)

  # return_type
  return_type = opts[:debug_return_type] || 'Refund'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.update_lease_refund",
    :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: LeasesApi#update_lease_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_lease_with_http_info(lease_id, save_lease, opts = {}) ⇒ Array<(Lease, Integer, Hash)>

Update a lease (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Updates an existing lease.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • lease_id (Integer) —

    Lease ID

  • save_lease (SaveLease) —

    lease

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

    the optional parameters

Returns:

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

    Lease data, response status code and response headers



2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
 
# File 'lib/propertyware/api/leases_api.rb', line 2430

def update_lease_with_http_info(lease_id, save_lease, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease ...'
  end
  # verify the required parameter 'lease_id' is set
  if @api_client.config.client_side_validation && lease_id.nil?
    fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.update_lease"
  end
  # verify the required parameter 'save_lease' is set
  if @api_client.config.client_side_validation && save_lease.nil?
    fail ArgumentError, "Missing the required parameter 'save_lease' when calling LeasesApi.update_lease"
  end
  # resource path
  local_var_path = '/leases/{leaseId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_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(save_lease)

  # return_type
  return_type = opts[:debug_return_type] || 'Lease'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"LeasesApi.update_lease",
    :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: LeasesApi#update_lease\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end