Class: Buildium::AssociationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssociationsApi

Returns a new instance of AssociationsApi.



19
20
21
 
# File 'lib/buildium-ruby/api/associations_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/associations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_association(association_post_message, opts = {}) ⇒ AssociationMessage

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

Parameters:

Returns:



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

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

#create_association_note(association_id, note_post_message, opts = {}) ⇒ NoteMessage

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

Parameters:

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

    the optional parameters

Returns:



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

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

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

Create a note Creates a 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; Associations and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • association_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/associations_api.rb', line 107

def create_association_note_with_http_info(association_id, note_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.create_association_note ...'
  end
  # verify the required parameter 'association_id' is set
  if @api_client.config.client_side_validation && association_id.nil?
    fail ArgumentError, "Missing the required parameter 'association_id' when calling AssociationsApi.create_association_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 AssociationsApi.create_association_note"
  end
  # resource path
  local_var_path = '/v1/associations/{associationId}/notes'.sub('{' + 'associationId' + '}', CGI.escape(association_id.to_s))

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

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

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

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

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

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

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

#create_association_with_http_info(association_post_message, opts = {}) ⇒ Array<(AssociationMessage, Integer, Hash)>

Create an association Creates an association. &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; Associations and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:

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

    AssociationMessage data, response status code and response headers



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

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

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

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

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

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

#create_board_member(association_id, association_board_member_post_message, opts = {}) ⇒ AssociationBoardMemberMessage

Create a board member Creates a board member for a given association. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Association owners and tenants</span> - ‘View` `Edit`

Parameters:

Returns:



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

def create_board_member(association_id, association_board_member_post_message, opts = {})
  data, _status_code, _headers = create_board_member_with_http_info(association_id, association_board_member_post_message, opts)
  data
end

#create_board_member_with_http_info(association_id, association_board_member_post_message, opts = {}) ⇒ Array<(AssociationBoardMemberMessage, Integer, Hash)>

Create a board member Creates a board member for a given association. &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; Association owners and tenants&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/associations_api.rb', line 181

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

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

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

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

#delete_board_member(association_id, board_member_id, opts = {}) ⇒ nil

Delete a board member Deletes a board member. Note, this is a hard delete from the database and data can not be restored. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Association owners and tenants</span> - ‘View` `Edit` `Delete`

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_board_member(association_id, board_member_id, opts = {})
  delete_board_member_with_http_info(association_id, board_member_id, opts)
  nil
end

#delete_board_member_with_http_info(association_id, board_member_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a board member Deletes a board member. Note, this is a hard delete from the database and data can not be restored. &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; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &#x60;Delete&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 255

def delete_board_member_with_http_info(association_id, board_member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.delete_board_member ...'
  end
  # verify the required parameter 'association_id' is set
  if @api_client.config.client_side_validation && association_id.nil?
    fail ArgumentError, "Missing the required parameter 'association_id' when calling AssociationsApi.delete_board_member"
  end
  # verify the required parameter 'board_member_id' is set
  if @api_client.config.client_side_validation && board_member_id.nil?
    fail ArgumentError, "Missing the required parameter 'board_member_id' when calling AssociationsApi.delete_board_member"
  end
  # resource path
  local_var_path = '/v1/associations/{associationId}/boardmembers/{boardMemberId}'.sub('{' + 'associationId' + '}', CGI.escape(association_id.to_s)).sub('{' + 'boardMemberId' + '}', CGI.escape(board_member_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]

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

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

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

#get_all_association_board_members(association_id, opts = {}) ⇒ Array<AssociationBoardMemberMessage>

Retrieve all board members Retrieves all association board members. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Association owners and tenants</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :statuses (Array<String>) —

    Filters results to only records whose status is equal to the specified values.

  • :boardpositiontypes (Array<String>) —

    Filters results to only records whose board position type is equal to the specified values.

  • :createddatetimeto (Time) —

    Filters results to only records that were created before this date. Must be formatted as &#x60;YYYY-MM-DD&#x60;.

  • :createddatetimefrom (Time) —

    Filters results to only records that were created after this date. Must be formatted as &#x60;YYYY-MM-DD&#x60;.

  • :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:



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

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

#get_all_association_board_members_with_http_info(association_id, opts = {}) ⇒ Array<(Array<AssociationBoardMemberMessage>, Integer, Hash)>

Retrieve all board members Retrieves all association board members. &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; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :statuses (Array<String>) —

    Filters results to only records whose status is equal to the specified values.

  • :boardpositiontypes (Array<String>) —

    Filters results to only records whose board position type is equal to the specified values.

  • :createddatetimeto (Time) —

    Filters results to only records that were created before this date. Must be formatted as &#x60;YYYY-MM-DD&#x60;.

  • :createddatetimefrom (Time) —

    Filters results to only records that were created after this date. Must be formatted as &#x60;YYYY-MM-DD&#x60;.

  • :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<AssociationBoardMemberMessage>, Integer, Hash)>) —

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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 336

def get_all_association_board_members_with_http_info(association_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all_association_board_members ...'
  end
  # verify the required parameter 'association_id' is set
  if @api_client.config.client_side_validation && association_id.nil?
    fail ArgumentError, "Missing the required parameter 'association_id' when calling AssociationsApi.get_all_association_board_members"
  end
  allowable_values = ["Current", "Former", "Future"]
  if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
  end
  allowable_values = ["President", "VicePresident", "Treasurer", "Secretary", "BoardMember"]
  if @api_client.config.client_side_validation && opts[:'boardpositiontypes'] && !opts[:'boardpositiontypes'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"boardpositiontypes\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/associations/{associationId}/boardmembers'.sub('{' + 'associationId' + '}', CGI.escape(association_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
  query_params[:'boardpositiontypes'] = @api_client.build_collection_param(opts[:'boardpositiontypes'], :multi) if !opts[:'boardpositiontypes'].nil?
  query_params[:'createddatetimeto'] = opts[:'createddatetimeto'] if !opts[:'createddatetimeto'].nil?
  query_params[:'createddatetimefrom'] = opts[:'createddatetimefrom'] if !opts[:'createddatetimefrom'].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<AssociationBoardMemberMessage>'

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

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

#get_association_board_member_by_id(association_id, board_member_id, opts = {}) ⇒ AssociationBoardMemberMessage

Retrieve a board member Retrieves an association board member. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Association owners and tenants</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



405
406
407
408
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 405

def get_association_board_member_by_id(association_id, board_member_id, opts = {})
  data, _status_code, _headers = get_association_board_member_by_id_with_http_info(association_id, board_member_id, opts)
  data
end

#get_association_board_member_by_id_with_http_info(association_id, board_member_id, opts = {}) ⇒ Array<(AssociationBoardMemberMessage, Integer, Hash)>

Retrieve a board member Retrieves an association board member. &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; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



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
459
460
461
462
463
464
465
466
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 416

def get_association_board_member_by_id_with_http_info(association_id, board_member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.get_association_board_member_by_id ...'
  end
  # verify the required parameter 'association_id' is set
  if @api_client.config.client_side_validation && association_id.nil?
    fail ArgumentError, "Missing the required parameter 'association_id' when calling AssociationsApi.get_association_board_member_by_id"
  end
  # verify the required parameter 'board_member_id' is set
  if @api_client.config.client_side_validation && board_member_id.nil?
    fail ArgumentError, "Missing the required parameter 'board_member_id' when calling AssociationsApi.get_association_board_member_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/{associationId}/boardmembers/{boardMemberId}'.sub('{' + 'associationId' + '}', CGI.escape(association_id.to_s)).sub('{' + 'boardMemberId' + '}', CGI.escape(board_member_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] || 'AssociationBoardMemberMessage'

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

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

#get_association_by_id(association_id, opts = {}) ⇒ AssociationMessage

Retrieve an association Retrieve a specific association. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Associations and units</span> - ‘View`

Parameters:

  • association_id (Integer) —

    The association identifier.

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

    the optional parameters

Returns:



473
474
475
476
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 473

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

#get_association_by_id_with_http_info(association_id, opts = {}) ⇒ Array<(AssociationMessage, Integer, Hash)>

Retrieve an association Retrieve a specific association. &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; Associations and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • association_id (Integer) —

    The association identifier.

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

    the optional parameters

Returns:

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

    AssociationMessage data, response status code and response headers



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
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 483

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

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

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

#get_association_note_by_note_id(association_id, note_id, opts = {}) ⇒ NoteMessage

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

Parameters:

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

    the optional parameters

Returns:



537
538
539
540
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 537

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

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

Retrieve a note Retrieves a 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; Associations and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • association_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



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 548

def get_association_note_by_note_id_with_http_info(association_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.get_association_note_by_note_id ...'
  end
  # verify the required parameter 'association_id' is set
  if @api_client.config.client_side_validation && association_id.nil?
    fail ArgumentError, "Missing the required parameter 'association_id' when calling AssociationsApi.get_association_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 AssociationsApi.get_association_note_by_note_id"
  end
  # resource path
  local_var_path = '/v1/associations/{associationId}/notes/{noteId}'.sub('{' + 'associationId' + '}', CGI.escape(association_id.to_s)).sub('{' + 'noteId' + '}', CGI.escape(note_id.to_s))

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

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

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

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

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

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

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

#get_association_notes(association_id, opts = {}) ⇒ Array<NoteMessage>

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

Parameters:

  • association_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:



611
612
613
614
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 611

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

#get_association_notes_with_http_info(association_id, opts = {}) ⇒ Array<(Array<NoteMessage>, Integer, Hash)>

Retrieve all notes Retrieves all notes. &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; Associations and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • association_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



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
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 627

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

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

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

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

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

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

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

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

#get_association_preferred_vendors(association_id, opts = {}) ⇒ Array<AssociationPreferredVendorMessage>

Retrieve all preferred vendors Retrieves all preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Associations and units</span> - ‘View` <br /><span class="permissionBlock">Maintenance &gt; Vendors</span> - `View`

Parameters:

  • association_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:



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

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

#get_association_preferred_vendors_with_http_info(association_id, opts = {}) ⇒ Array<(Array<AssociationPreferredVendorMessage>, Integer, Hash)>

Retrieve all preferred vendors Retrieves all preferred vendors. &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; Associations and units&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Maintenance &amp;gt; Vendors&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • association_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:



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
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 702

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

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

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

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

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

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

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

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

#get_associations(opts = {}) ⇒ Array<AssociationMessage>

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :location (String) —

    Filters results to any association whose city or state contains the specified value.

  • :status (String) —

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

  • :lastupdatedfrom (Time) —

    Filters results to any associations that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :lastupdatedto (Time) —

    Filters results to any associations that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :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:



764
765
766
767
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 764

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

#get_associations_with_http_info(opts = {}) ⇒ Array<(Array<AssociationMessage>, Integer, Hash)>

Retrieve all associations Retrieves a list of associations. &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; Associations and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :location (String) —

    Filters results to any association whose city or state contains the specified value.

  • :status (String) —

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

  • :lastupdatedfrom (Time) —

    Filters results to any associations that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :lastupdatedto (Time) —

    Filters results to any associations that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :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<AssociationMessage>, Integer, Hash)>) —

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



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 780

def get_associations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.get_associations ...'
  end
  allowable_values = ["Active", "InActive"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/associations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
  query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].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<AssociationMessage>'

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

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

#update_association(association_id, association_put_message, opts = {}) ⇒ AssociationMessage

Update an association Updates an association. <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; Associations and units</span> - ‘View` `Edit`

Parameters:

  • association_id (Integer)
  • association_put_message (AssociationPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



841
842
843
844
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 841

def update_association(association_id, association_put_message, opts = {})
  data, _status_code, _headers = update_association_with_http_info(association_id, association_put_message, opts)
  data
end

#update_association_note(association_id, note_id, note_put_message, opts = {}) ⇒ NoteMessage

Update a note Updates a 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; Associations and units</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



916
917
918
919
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 916

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

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

Update a note Updates a 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; Associations and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • association_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



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

def update_association_note_with_http_info(association_id, note_id, note_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.update_association_note ...'
  end
  # verify the required parameter 'association_id' is set
  if @api_client.config.client_side_validation && association_id.nil?
    fail ArgumentError, "Missing the required parameter 'association_id' when calling AssociationsApi.update_association_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 AssociationsApi.update_association_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 AssociationsApi.update_association_note"
  end
  # resource path
  local_var_path = '/v1/associations/{associationId}/notes/{noteId}'.sub('{' + 'associationId' + '}', CGI.escape(association_id.to_s)).sub('{' + 'noteId' + '}', CGI.escape(note_id.to_s))

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

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

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

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

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

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

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

#update_association_preferred_vendors(association_id, association_preferred_vendor_put_message, opts = {}) ⇒ Array<AssociationPreferredVendorMessage>

Update preferred vendors Updates preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Associations and units</span> - ‘View` `Edit` <br /><span class="permissionBlock">Maintenance &gt; Vendors</span> - `View` `Edit`

Parameters:

Returns:



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

def update_association_preferred_vendors(association_id, association_preferred_vendor_put_message, opts = {})
  data, _status_code, _headers = update_association_preferred_vendors_with_http_info(association_id, association_preferred_vendor_put_message, opts)
  data
end

#update_association_preferred_vendors_with_http_info(association_id, association_preferred_vendor_put_message, opts = {}) ⇒ Array<(Array<AssociationPreferredVendorMessage>, Integer, Hash)>

Update preferred vendors Updates preferred vendors. &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; Associations and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Maintenance &amp;gt; Vendors&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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

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

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

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

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

#update_association_with_http_info(association_id, association_put_message, opts = {}) ⇒ Array<(AssociationMessage, Integer, Hash)>

Update an association Updates an association. &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; Associations and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • association_id (Integer)
  • association_put_message (AssociationPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AssociationMessage data, response status code and response headers



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

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

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

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

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

#update_board_member(association_id, board_member_id, association_board_member_put_message, opts = {}) ⇒ AssociationBoardMemberMessage

Update a board member Updates a board member for a given association. <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; Association owners and tenants</span> - ‘View` `Edit`

Parameters:

  • association_id (Integer)
  • board_member_id (Integer)
  • association_board_member_put_message (AssociationBoardMemberPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1070
1071
1072
1073
 
# File 'lib/buildium-ruby/api/associations_api.rb', line 1070

def update_board_member(association_id, board_member_id, association_board_member_put_message, opts = {})
  data, _status_code, _headers = update_board_member_with_http_info(association_id, board_member_id, association_board_member_put_message, opts)
  data
end

#update_board_member_with_http_info(association_id, board_member_id, association_board_member_put_message, opts = {}) ⇒ Array<(AssociationBoardMemberMessage, Integer, Hash)>

Update a board member Updates a board member for a given association. &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; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • association_id (Integer)
  • board_member_id (Integer)
  • association_board_member_put_message (AssociationBoardMemberPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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

def update_board_member_with_http_info(association_id, board_member_id, association_board_member_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.update_board_member ...'
  end
  # verify the required parameter 'association_id' is set
  if @api_client.config.client_side_validation && association_id.nil?
    fail ArgumentError, "Missing the required parameter 'association_id' when calling AssociationsApi.update_board_member"
  end
  # verify the required parameter 'board_member_id' is set
  if @api_client.config.client_side_validation && board_member_id.nil?
    fail ArgumentError, "Missing the required parameter 'board_member_id' when calling AssociationsApi.update_board_member"
  end
  # verify the required parameter 'association_board_member_put_message' is set
  if @api_client.config.client_side_validation && association_board_member_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'association_board_member_put_message' when calling AssociationsApi.update_board_member"
  end
  # resource path
  local_var_path = '/v1/associations/{associationId}/boardmembers/{boardMemberId}'.sub('{' + 'associationId' + '}', CGI.escape(association_id.to_s)).sub('{' + 'boardMemberId' + '}', CGI.escape(board_member_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(association_board_member_put_message)

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

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

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