Class: Buildium::AssociationOwnershipAccountsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssociationOwnershipAccountsApi

Returns a new instance of AssociationOwnershipAccountsApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#create_association_ownership_account(association_ownership_account_post_message, opts = {}) ⇒ AssociationOwnershipAccountMessage

Create an ownership account Creates an ownership account. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership accounts</span> - ‘View` `Edit` <br /><span class="permissionBlock">Associations &gt; Owners</span> - `View` `Edit`

Parameters:

Returns:



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

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

#create_association_ownership_account_note(ownership_account_id, note_post_message, opts = {}) ⇒ NoteMessage

Create a note Creates a new ownership account note. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership accounts</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



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

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

#create_association_ownership_account_note_with_http_info(ownership_account_id, note_post_message, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

Create a note Creates a new ownership account note. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    NoteMessage data, response status code and response headers



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

def (, note_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_association_ownership_account_note ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.create_association_ownership_account_note"
  end
  # verify the required parameter 'note_post_message' is set
  if @api_client.config.client_side_validation && note_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'note_post_message' when calling AssociationOwnershipAccountsApi.create_association_ownership_account_note"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/notes'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

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

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

#create_association_ownership_account_with_http_info(association_ownership_account_post_message, opts = {}) ⇒ Array<(AssociationOwnershipAccountMessage, Integer, Hash)>

Create an ownership account Creates an ownership account. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Owners&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_association_ownership_account ...'
  end
  # verify the required parameter 'association_ownership_account_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'association_ownership_account_post_message' when calling AssociationOwnershipAccountsApi.create_association_ownership_account"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts'

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

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

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

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

#create_ownership_account_credit(ownership_account_id, ownership_account_credit_post_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Create a ledger credit Creates a ledger credit. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



170
171
172
173
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 170

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

#create_ownership_account_credit_recurring_transaction(ownership_account_id, credit_recurring_transaction_post_message, opts = {}) ⇒ OwnershipAccountRecurringCreditMessage

Create a recurring credit Creates a recurring credit transaction that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



244
245
246
247
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 244

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

#create_ownership_account_credit_recurring_transaction_with_http_info(ownership_account_id, credit_recurring_transaction_post_message, opts = {}) ⇒ Array<(OwnershipAccountRecurringCreditMessage, Integer, Hash)>

Create a recurring credit Creates a recurring credit transaction that will post automatically on the specified ownership account ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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
305
306
307
308
309
310
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 255

def (, credit_recurring_transaction_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_ownership_account_credit_recurring_transaction ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.create_ownership_account_credit_recurring_transaction"
  end
  # verify the required parameter 'credit_recurring_transaction_post_message' is set
  if @api_client.config.client_side_validation && credit_recurring_transaction_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'credit_recurring_transaction_post_message' when calling AssociationOwnershipAccountsApi.create_ownership_account_credit_recurring_transaction"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcredits'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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(credit_recurring_transaction_post_message)

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

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

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

#create_ownership_account_credit_with_http_info(ownership_account_id, ownership_account_credit_post_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Create a ledger credit Creates a ledger credit. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_ownership_account_credit ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.create_ownership_account_credit"
  end
  # verify the required parameter 'ownership_account_credit_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_credit_post_message' when calling AssociationOwnershipAccountsApi.create_ownership_account_credit"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/credits'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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()

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

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

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

#create_ownership_account_deposit_withholding(ownership_account_id, ownership_account_deposit_withholding_post_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Create a deposit withholding Withholds an association owner deposit by reallocating the funds from a liability account to an income account to cover an expense(s). <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit` <span class="permissionBlock">Accounting &gt; General Ledger Accounts</span> - `View`

Parameters:

Returns:



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

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

#create_ownership_account_deposit_withholding_with_http_info(ownership_account_id, ownership_account_deposit_withholding_post_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Create a deposit withholding Withholds an association owner deposit by reallocating the funds from a liability account to an income account to cover an expense(s). &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; General Ledger Accounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

Returns:



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
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 329

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_ownership_account_deposit_withholding ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.create_ownership_account_deposit_withholding"
  end
  # verify the required parameter 'ownership_account_deposit_withholding_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_deposit_withholding_post_message' when calling AssociationOwnershipAccountsApi.create_ownership_account_deposit_withholding"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/applieddeposits'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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()

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

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

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

#create_ownership_account_ledger_charge(ownership_account_id, ownership_account_ledger_charge_post_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Create a ledger charge Creates a ledger charge. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit` <br />

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Returns:



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

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

#create_ownership_account_ledger_charge_with_http_info(ownership_account_id, ownership_account_ledger_charge_post_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Create a ledger charge Creates a ledger charge. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Returns:



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

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_ownership_account_ledger_charge ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.create_ownership_account_ledger_charge"
  end
  # verify the required parameter 'ownership_account_ledger_charge_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_ledger_charge_post_message' when calling AssociationOwnershipAccountsApi.create_ownership_account_ledger_charge"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/charges'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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()

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

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

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

#create_ownership_account_ledger_payment(ownership_account_id, ownership_account_ledger_payment_post_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Create a ledger payment Creates a ledger payment. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



466
467
468
469
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 466

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

#create_ownership_account_ledger_payment_with_http_info(ownership_account_id, ownership_account_ledger_payment_post_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Create a ledger payment Creates a ledger payment. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 477

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_ownership_account_ledger_payment ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.create_ownership_account_ledger_payment"
  end
  # verify the required parameter 'ownership_account_ledger_payment_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_ledger_payment_post_message' when calling AssociationOwnershipAccountsApi.create_ownership_account_ledger_payment"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/payments'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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()

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

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

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

#create_ownership_account_recurring_payment(ownership_account_id, payment_recurring_transaction_post_message, opts = {}) ⇒ OwnershipAccountRecurringPaymentMessage

Create a recurring payment Creates a recurring payment that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



540
541
542
543
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 540

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

#create_ownership_account_recurring_payment_with_http_info(ownership_account_id, payment_recurring_transaction_post_message, opts = {}) ⇒ Array<(OwnershipAccountRecurringPaymentMessage, Integer, Hash)>

Create a recurring payment Creates a recurring payment that will post automatically on the specified ownership account ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 551

def (, payment_recurring_transaction_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_ownership_account_recurring_payment ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.create_ownership_account_recurring_payment"
  end
  # verify the required parameter 'payment_recurring_transaction_post_message' is set
  if @api_client.config.client_side_validation && payment_recurring_transaction_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'payment_recurring_transaction_post_message' when calling AssociationOwnershipAccountsApi.create_ownership_account_recurring_payment"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringpayments'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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(payment_recurring_transaction_post_message)

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

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

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

#create_ownership_account_refund(ownership_account_id, ownership_account_refund_post_message, opts = {}) ⇒ OwnershipAccountRefundMessage

Create a refund Creates a refund. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View` `Edit`

Parameters:

Returns:



614
615
616
617
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 614

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

#create_ownership_account_refund_with_http_info(ownership_account_id, ownership_account_refund_post_message, opts = {}) ⇒ Array<(OwnershipAccountRefundMessage, Integer, Hash)>

Create a refund Creates a refund. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 625

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_ownership_account_refund ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.create_ownership_account_refund"
  end
  # verify the required parameter 'ownership_account_refund_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_refund_post_message' when calling AssociationOwnershipAccountsApi.create_ownership_account_refund"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/refunds'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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()

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

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

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

#create_ownership_accounts_charge_recurring_transaction(ownership_account_id, charge_recurring_transaction_post_message, opts = {}) ⇒ OwnershipAccountChargeRecurringTransactionMessage

Create a recurring charge Creates a recurring charge transaction that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



688
689
690
691
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 688

def create_ownership_accounts_charge_recurring_transaction(, charge_recurring_transaction_post_message, opts = {})
  data, _status_code, _headers = create_ownership_accounts_charge_recurring_transaction_with_http_info(, charge_recurring_transaction_post_message, opts)
  data
end

#create_ownership_accounts_charge_recurring_transaction_with_http_info(ownership_account_id, charge_recurring_transaction_post_message, opts = {}) ⇒ Array<(OwnershipAccountChargeRecurringTransactionMessage, Integer, Hash)>

Create a recurring charge Creates a recurring charge transaction that will post automatically on the specified ownership account ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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

def create_ownership_accounts_charge_recurring_transaction_with_http_info(, charge_recurring_transaction_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.create_ownership_accounts_charge_recurring_transaction ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.create_ownership_accounts_charge_recurring_transaction"
  end
  # verify the required parameter 'charge_recurring_transaction_post_message' is set
  if @api_client.config.client_side_validation && charge_recurring_transaction_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'charge_recurring_transaction_post_message' when calling AssociationOwnershipAccountsApi.create_ownership_accounts_charge_recurring_transaction"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcharges'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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(charge_recurring_transaction_post_message)

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

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

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

#get_all_ownership_accounts(opts = {}) ⇒ Array<AssociationOwnershipAccountMessage>

Retrieve all ownership accounts Retrieves a list of ownership accounts. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership accounts</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :associationids (Array<Integer>) —

    Filters results to any ownership accounts who belong to the specified set of association ids.

  • :unitorowner (String) —

    Filters results to any association whose unit or owner contains the specified value.

  • :datefrom (Date) —

    Filters results to any ownership account whose start date is greater than or equal to the specified value.

  • :dateto (Date) —

    Filters results to any ownership account whose start date is less than or equal to the specified value.

  • :status (Array<String>) —

    Filters results by the status of the association. If no status is specified, &#x60;active&#x60;, &#x60;past&#x60; and &#x60;future&#x60; associations will be returned.

  • :delinquencystatuses (Array<String>) —

    Filters results by the delinquency status of the ownership account. If no status is specified, ownership accounts of any delinquency status will be returned.

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



769
770
771
772
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 769

def get_all_ownership_accounts(opts = {})
  data, _status_code, _headers = get_all_ownership_accounts_with_http_info(opts)
  data
end

#get_all_ownership_accounts_with_http_info(opts = {}) ⇒ Array<(Array<AssociationOwnershipAccountMessage>, Integer, Hash)>

Retrieve all ownership accounts Retrieves a list of ownership accounts. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :associationids (Array<Integer>) —

    Filters results to any ownership accounts who belong to the specified set of association ids.

  • :unitorowner (String) —

    Filters results to any association whose unit or owner contains the specified value.

  • :datefrom (Date) —

    Filters results to any ownership account whose start date is greater than or equal to the specified value.

  • :dateto (Date) —

    Filters results to any ownership account whose start date is less than or equal to the specified value.

  • :status (Array<String>) —

    Filters results by the status of the association. If no status is specified, &#x60;active&#x60;, &#x60;past&#x60; and &#x60;future&#x60; associations will be returned.

  • :delinquencystatuses (Array<String>) —

    Filters results by the delinquency status of the ownership account. If no status is specified, ownership accounts of any delinquency status will be returned.

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
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
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 787

def get_all_ownership_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_all_ownership_accounts ...'
  end
  allowable_values = ["Active", "Past", "Future"]
  if @api_client.config.client_side_validation && opts[:'status'] && !opts[:'status'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"status\", must include one of #{allowable_values}"
  end
  allowable_values = ["NoDelinquency", "InCollections", "InForeclosure", "Foreclosed"]
  if @api_client.config.client_side_validation && opts[:'delinquencystatuses'] && !opts[:'delinquencystatuses'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"delinquencystatuses\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'associationids'] = @api_client.build_collection_param(opts[:'associationids'], :multi) if !opts[:'associationids'].nil?
  query_params[:'unitorowner'] = opts[:'unitorowner'] if !opts[:'unitorowner'].nil?
  query_params[:'datefrom'] = opts[:'datefrom'] if !opts[:'datefrom'].nil?
  query_params[:'dateto'] = opts[:'dateto'] if !opts[:'dateto'].nil?
  query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :multi) if !opts[:'status'].nil?
  query_params[:'delinquencystatuses'] = @api_client.build_collection_param(opts[:'delinquencystatuses'], :multi) if !opts[:'delinquencystatuses'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#get_association_ownership_account_note_by_note_id(ownership_account_id, note_id, opts = {}) ⇒ NoteMessage

Retrieve a note Retrieves an ownership account note. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; OwnershipAccounts</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



854
855
856
857
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 854

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

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

Retrieve a note Retrieves an ownership account note. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; OwnershipAccounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    NoteMessage data, response status code and response headers



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

def (, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_association_ownership_account_note_by_note_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_association_ownership_account_note_by_note_id"
  end
  # verify the required parameter 'note_id' is set
  if @api_client.config.client_side_validation && note_id.nil?
    fail ArgumentError, "Missing the required parameter 'note_id' when calling AssociationOwnershipAccountsApi.get_association_ownership_account_note_by_note_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/notes/{noteId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'noteId' + '}', CGI.escape(note_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

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

#get_association_ownership_account_notes(ownership_account_id, opts = {}) ⇒ Array<NoteMessage>

Retrieve all notes Retrieves notes for an ownership account. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; OwnershipAccounts</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :updateddatetimefrom (Time) —

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

  • :updateddatetimeto (Time) —

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

  • :lastupdatedbyuserid (Integer) —

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

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



928
929
930
931
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 928

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

#get_association_ownership_account_notes_with_http_info(ownership_account_id, opts = {}) ⇒ Array<(Array<NoteMessage>, Integer, Hash)>

Retrieve all notes Retrieves notes for an ownership account. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; OwnershipAccounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :updateddatetimefrom (Time) —

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

  • :updateddatetimeto (Time) —

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

  • :lastupdatedbyuserid (Integer) —

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

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:

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

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



944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 944

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_association_ownership_account_notes ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_association_ownership_account_notes"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/notes'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'updateddatetimefrom'] = opts[:'updateddatetimefrom'] if !opts[:'updateddatetimefrom'].nil?
  query_params[:'updateddatetimeto'] = opts[:'updateddatetimeto'] if !opts[:'updateddatetimeto'].nil?
  query_params[:'lastupdatedbyuserid'] = opts[:'lastupdatedbyuserid'] if !opts[:'lastupdatedbyuserid'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#get_association_recurring_transaction(ownership_account_id, opts = {}) ⇒ Array<RecurringTransactionMessage>

Retrieve all recurring transactions Retrieves all recurring transactions for an ownership account. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



1006
1007
1008
1009
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1006

def get_association_recurring_transaction(, opts = {})
  data, _status_code, _headers = get_association_recurring_transaction_with_http_info(, opts)
  data
end

#get_association_recurring_transaction_with_http_info(ownership_account_id, opts = {}) ⇒ Array<(Array<RecurringTransactionMessage>, Integer, Hash)>

Retrieve all recurring transactions Retrieves all recurring transactions for an ownership account. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:

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

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



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
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1019

def get_association_recurring_transaction_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_association_recurring_transaction ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_association_recurring_transaction"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringtransactions'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#get_ownership_account_by_id(ownership_account_id, opts = {}) ⇒ AssociationOwnershipAccountMessage

Retrieve an ownership account Retrieves a specific ownership account. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership accounts</span> - ‘View`

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Returns:



1075
1076
1077
1078
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1075

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

#get_ownership_account_by_id_with_http_info(ownership_account_id, opts = {}) ⇒ Array<(AssociationOwnershipAccountMessage, Integer, Hash)>

Retrieve an ownership account Retrieves a specific ownership account. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Returns:



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_ownership_account_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_ownership_account_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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] || 'AssociationOwnershipAccountMessage'

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

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

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

#get_ownership_account_ledger(ownership_account_id, opts = {}) ⇒ Array<OwnershipAccountTransactionMessage>

Retrieve ownership account transactions Retrieves all transactions for a specific ownership account. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Options Hash (opts):

  • :transactiondatefrom (Date) —

    Filters results to any lease transaction whose start date is greater than or equal to the specified value.

  • :transactiondateto (Date) —

    Filters results to any lease transaction whose end date is less than or equal to the specified value.

  • :transactiontypes (Array<String>) —

    Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned.

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



1144
1145
1146
1147
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1144

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

#get_ownership_account_ledger_with_http_info(ownership_account_id, opts = {}) ⇒ Array<(Array<OwnershipAccountTransactionMessage>, Integer, Hash)>

Retrieve ownership account transactions Retrieves all transactions for a specific ownership account. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Options Hash (opts):

  • :transactiondatefrom (Date) —

    Filters results to any lease transaction whose start date is greater than or equal to the specified value.

  • :transactiondateto (Date) —

    Filters results to any lease transaction whose end date is less than or equal to the specified value.

  • :transactiontypes (Array<String>) —

    Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned.

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1160

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_ownership_account_ledger ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_ownership_account_ledger"
  end
  allowable_values = ["Bill", "Check", "Charge", "Payment", "Credit", "Refund", "ApplyDeposit", "ElectronicFundsTransfer", "Other", "Deposit", "GeneralJournalEntry", "OwnerContribution", "ReversePayment", "ReverseElectronicFundsTransfer", "VendorCredit", "RentalApplicationFeePayment", "ReverseRentalApplicationFeePayment", "ReverseOwnerContribution", "VendorRefund", "UnreversedPayment", "UnreversedElectronicFundsTransfer", "UnreversedOwnerContribution", "UnreversedRentalApplicationFeePayment"]
  if @api_client.config.client_side_validation && opts[:'transactiontypes'] && !opts[:'transactiontypes'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"transactiontypes\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/transactions'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'transactiondatefrom'] = opts[:'transactiondatefrom'] if !opts[:'transactiondatefrom'].nil?
  query_params[:'transactiondateto'] = opts[:'transactiondateto'] if !opts[:'transactiondateto'].nil?
  query_params[:'transactiontypes'] = @api_client.build_collection_param(opts[:'transactiontypes'], :multi) if !opts[:'transactiontypes'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#get_ownership_account_outstanding_balances(opts = {}) ⇒ Array<OwnershipAccountOutstandingBalanceMessage>

Retrieve all outstanding balances Retrieves a list of ownership account outstanding balances. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Outstanding Balances</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :associationid (Integer) —

    Association unique identifier

  • :ownershipaccountstatuses (Array<String>) —

    List of ownership account statuses

  • :ownershipaccountids (Array<Integer>) —

    List of ownership account ids

  • :pastdueemail (String) —

    Status of notification of outstanding balances

  • :balanceduration (String) —

    Duration of outstanding balances

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



1230
1231
1232
1233
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1230

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

#get_ownership_account_outstanding_balances_with_http_info(opts = {}) ⇒ Array<(Array<OwnershipAccountOutstandingBalanceMessage>, Integer, Hash)>

Retrieve all outstanding balances Retrieves a list of ownership account outstanding balances. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Outstanding Balances&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :associationid (Integer) —

    Association unique identifier

  • :ownershipaccountstatuses (Array<String>) —

    List of ownership account statuses

  • :ownershipaccountids (Array<Integer>) —

    List of ownership account ids

  • :pastdueemail (String) —

    Status of notification of outstanding balances

  • :balanceduration (String) —

    Duration of outstanding balances

  • :orderby (String) —

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

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1247

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_ownership_account_outstanding_balances ...'
  end
  allowable_values = ["Active", "Past", "Future"]
  if @api_client.config.client_side_validation && opts[:'ownershipaccountstatuses'] && !opts[:'ownershipaccountstatuses'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ownershipaccountstatuses\", must include one of #{allowable_values}"
  end
  allowable_values = ["NoEmailAddress", "Sent"]
  if @api_client.config.client_side_validation && opts[:'pastdueemail'] && !allowable_values.include?(opts[:'pastdueemail'])
    fail ArgumentError, "invalid value for \"pastdueemail\", must be one of #{allowable_values}"
  end
  allowable_values = ["TotalBalance", "Balance0to30Days", "Balance31to60Days", "Balance61to90Days", "BalanceOver90Days"]
  if @api_client.config.client_side_validation && opts[:'balanceduration'] && !allowable_values.include?(opts[:'balanceduration'])
    fail ArgumentError, "invalid value for \"balanceduration\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/outstandingbalances'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'associationid'] = opts[:'associationid'] if !opts[:'associationid'].nil?
  query_params[:'ownershipaccountstatuses'] = @api_client.build_collection_param(opts[:'ownershipaccountstatuses'], :multi) if !opts[:'ownershipaccountstatuses'].nil?
  query_params[:'ownershipaccountids'] = @api_client.build_collection_param(opts[:'ownershipaccountids'], :multi) if !opts[:'ownershipaccountids'].nil?
  query_params[:'pastdueemail'] = opts[:'pastdueemail'] if !opts[:'pastdueemail'].nil?
  query_params[:'balanceduration'] = opts[:'balanceduration'] if !opts[:'balanceduration'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#get_ownership_account_recurring_credit_by_id(ownership_account_id, transaction_id, opts = {}) ⇒ OwnershipAccountRecurringCreditMessage

Retrieve a recurring credit Retrieves a recurring credit. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



1317
1318
1319
1320
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1317

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

#get_ownership_account_recurring_credit_by_id_with_http_info(ownership_account_id, transaction_id, opts = {}) ⇒ Array<(OwnershipAccountRecurringCreditMessage, Integer, Hash)>

Retrieve a recurring credit Retrieves a recurring credit. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1328

def (, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_ownership_account_recurring_credit_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_ownership_account_recurring_credit_by_id"
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling AssociationOwnershipAccountsApi.get_ownership_account_recurring_credit_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcredits/{transactionId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_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] || 'OwnershipAccountRecurringCreditMessage'

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

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

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

#get_ownership_account_refund_by_id(ownership_account_id, refund_id, opts = {}) ⇒ OwnershipAccountRefundMessage

Retrieve a refund Retrieves a refund. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



1386
1387
1388
1389
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1386

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

#get_ownership_account_refund_by_id_with_http_info(ownership_account_id, refund_id, opts = {}) ⇒ Array<(OwnershipAccountRefundMessage, Integer, Hash)>

Retrieve a refund Retrieves a refund. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
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
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1397

def (, refund_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_ownership_account_refund_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_ownership_account_refund_by_id"
  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 AssociationOwnershipAccountsApi.get_ownership_account_refund_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/refunds/{refundId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).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'])

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

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

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

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

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

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

#get_ownership_account_transaction_by_id(ownership_account_id, transaction_id, opts = {}) ⇒ OwnershipAccountTransactionMessage

Retrieve an ownership account transaction Retrieves a single ownership account transaction. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

  • transaction_id (Integer) —

    The transaction identifier.

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

    the optional parameters

Returns:



1455
1456
1457
1458
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1455

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

#get_ownership_account_transaction_by_id_with_http_info(ownership_account_id, transaction_id, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Retrieve an ownership account transaction Retrieves a single ownership account transaction. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

  • transaction_id (Integer) —

    The transaction identifier.

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

    the optional parameters

Returns:



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1466

def (, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_ownership_account_transaction_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_ownership_account_transaction_by_id"
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling AssociationOwnershipAccountsApi.get_ownership_account_transaction_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/transactions/{transactionId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_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] || 'OwnershipAccountTransactionMessage'

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

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

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

#get_ownership_accounts_charge_recurring_transaction_by_id(ownership_account_id, transaction_id, opts = {}) ⇒ OwnershipAccountChargeRecurringTransactionMessage

Retrieve a recurring charge Retrieves a recurring charge. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



1524
1525
1526
1527
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1524

def get_ownership_accounts_charge_recurring_transaction_by_id(, transaction_id, opts = {})
  data, _status_code, _headers = get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(, transaction_id, opts)
  data
end

#get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(ownership_account_id, transaction_id, opts = {}) ⇒ Array<(OwnershipAccountChargeRecurringTransactionMessage, Integer, Hash)>

Retrieve a recurring charge Retrieves a recurring charge. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1535

def get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_ownership_accounts_charge_recurring_transaction_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_ownership_accounts_charge_recurring_transaction_by_id"
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling AssociationOwnershipAccountsApi.get_ownership_accounts_charge_recurring_transaction_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcharges/{transactionId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_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] || 'OwnershipAccountChargeRecurringTransactionMessage'

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

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

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

#get_recurring_ownership_account_payments_by_id(ownership_account_id, payment_id, opts = {}) ⇒ OwnershipAccountRecurringPaymentMessage

Retrieve a recurring payment Retrieves a recurring payment. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



1593
1594
1595
1596
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1593

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

#get_recurring_ownership_account_payments_by_id_with_http_info(ownership_account_id, payment_id, opts = {}) ⇒ Array<(OwnershipAccountRecurringPaymentMessage, Integer, Hash)>

Retrieve a recurring payment Retrieves a recurring payment. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



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
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1604

def (, payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.get_recurring_ownership_account_payments_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.get_recurring_ownership_account_payments_by_id"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling AssociationOwnershipAccountsApi.get_recurring_ownership_account_payments_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringpayments/{paymentId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'paymentId' + '}', CGI.escape(payment_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] || 'OwnershipAccountRecurringPaymentMessage'

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

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

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

#update_association_ownership_account(ownership_account_id, association_ownership_account_put_message, opts = {}) ⇒ AssociationOwnershipAccountMessage

Update an ownership account Updates an ownership account. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership accounts</span> - ‘View` `Edit`

Parameters:

Returns:



1662
1663
1664
1665
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1662

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

#update_association_ownership_account_note(ownership_account_id, note_id, note_put_message, opts = {}) ⇒ NoteMessage

Update a note Updates an association ownership account note. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership Accounts</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



1737
1738
1739
1740
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1737

def (, note_id, note_put_message, opts = {})
  data, _status_code, _headers = (, note_id, note_put_message, opts)
  data
end

#update_association_ownership_account_note_with_http_info(ownership_account_id, note_id, note_put_message, opts = {}) ⇒ Array<(NoteMessage, Integer, Hash)>

Update a note Updates an association ownership account note. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    NoteMessage data, response status code and response headers



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
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1749

def (, note_id, note_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.update_association_ownership_account_note ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.update_association_ownership_account_note"
  end
  # verify the required parameter 'note_id' is set
  if @api_client.config.client_side_validation && note_id.nil?
    fail ArgumentError, "Missing the required parameter 'note_id' when calling AssociationOwnershipAccountsApi.update_association_ownership_account_note"
  end
  # verify the required parameter 'note_put_message' is set
  if @api_client.config.client_side_validation && note_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'note_put_message' when calling AssociationOwnershipAccountsApi.update_association_ownership_account_note"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/notes/{noteId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'noteId' + '}', CGI.escape(note_id.to_s))

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

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

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

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

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

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

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

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

#update_association_ownership_account_with_http_info(ownership_account_id, association_ownership_account_put_message, opts = {}) ⇒ Array<(AssociationOwnershipAccountMessage, Integer, Hash)>

Update an ownership account Updates an ownership account. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1673

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.update_association_ownership_account ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.update_association_ownership_account"
  end
  # verify the required parameter 'association_ownership_account_put_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'association_ownership_account_put_message' when calling AssociationOwnershipAccountsApi.update_association_ownership_account"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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()

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

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

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

#update_ownership_account_charge(ownership_account_id, charge_id, ownership_account_ledger_charge_put_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Update a charge Updates a charge. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit` <br />

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

  • charge_id (Integer) —

    The charge identifier.

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

    the optional parameters

Returns:



1817
1818
1819
1820
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1817

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

#update_ownership_account_charge_with_http_info(ownership_account_id, charge_id, ownership_account_ledger_charge_put_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Update a charge Updates a charge. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

  • charge_id (Integer) —

    The charge identifier.

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

    the optional parameters

Returns:



1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/buildium-ruby/api/association_ownership_accounts_api.rb', line 1829

def (, charge_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnershipAccountsApi.update_ownership_account_charge ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling AssociationOwnershipAccountsApi.update_ownership_account_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 AssociationOwnershipAccountsApi.update_ownership_account_charge"
  end
  # verify the required parameter 'ownership_account_ledger_charge_put_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_ledger_charge_put_message' when calling AssociationOwnershipAccountsApi.update_ownership_account_charge"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/charges/{chargeId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).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()

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

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

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