Class: Buildium::BoardMembersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BoardMembersApi

Returns a new instance of BoardMembersApi.



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

def api_client
  @api_client
end

Instance Method Details

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



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

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:



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
89
90
91
92
93
94
 
# File 'lib/buildium-ruby/api/board_members_api.rb', line 39

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: BoardMembersApi.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 BoardMembersApi.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 BoardMembersApi.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 => :"BoardMembersApi.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: BoardMembersApi#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) 


102
103
104
105
 
# File 'lib/buildium-ruby/api/board_members_api.rb', line 102

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



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

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: BoardMembersApi.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 BoardMembersApi.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 BoardMembersApi.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 => :"BoardMembersApi.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: BoardMembersApi#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:



177
178
179
180
 
# File 'lib/buildium-ruby/api/board_members_api.rb', line 177

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



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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/buildium-ruby/api/board_members_api.rb', line 194

def get_all_association_board_members_with_http_info(association_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BoardMembersApi.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 BoardMembersApi.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 => :"BoardMembersApi.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: BoardMembersApi#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:



263
264
265
266
 
# File 'lib/buildium-ruby/api/board_members_api.rb', line 263

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:



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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/buildium-ruby/api/board_members_api.rb', line 274

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: BoardMembersApi.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 BoardMembersApi.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 BoardMembersApi.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 => :"BoardMembersApi.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: BoardMembersApi#get_association_board_member_by_id\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:



333
334
335
336
 
# File 'lib/buildium-ruby/api/board_members_api.rb', line 333

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:



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
398
399
400
401
402
403
404
 
# File 'lib/buildium-ruby/api/board_members_api.rb', line 345

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