Class: Buildium::AssociationOwnersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssociationOwnersApi

Returns a new instance of AssociationOwnersApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#create_association_owner(association_owner_to_existing_ownership_account_post_message, opts = {}) ⇒ AssociationOwnerMessage

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

Parameters:

Returns:



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

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

#create_association_owner_note(owner_id, note_post_message, opts = {}) ⇒ NoteMessage

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

Parameters:

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

    the optional parameters

Returns:



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

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

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

Create a note Creates an association owner 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; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    NoteMessage data, response status code and response headers



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

def create_association_owner_note_with_http_info(owner_id, note_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnersApi.create_association_owner_note ...'
  end
  # verify the required parameter 'owner_id' is set
  if @api_client.config.client_side_validation && owner_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_id' when calling AssociationOwnersApi.create_association_owner_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 AssociationOwnersApi.create_association_owner_note"
  end
  # resource path
  local_var_path = '/v1/associations/owners/{ownerId}/notes'.sub('{' + 'ownerId' + '}', CGI.escape(owner_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 => :"AssociationOwnersApi.create_association_owner_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: AssociationOwnersApi#create_association_owner_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_association_owner_with_http_info(association_owner_to_existing_ownership_account_post_message, opts = {}) ⇒ Array<(AssociationOwnerMessage, Integer, Hash)>

Create an owner Creates an association owner. &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; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:

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

    AssociationOwnerMessage 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/association_owners_api.rb', line 37

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

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

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

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

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

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

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

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

#get_all_association_owners(opts = {}) ⇒ Array<AssociationOwnerMessage>

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filters results to only records whose name contains the specified value.

  • :phone (String) —

    Filters results to only records whose phone number contains the specified value.

  • :email (String) —

    Filters results to only records whose email contains the specified value.

  • :associationids (Array<Integer>) —

    Filters results to only records that belong to the specified set of association identifiers.

  • :statuses (Array<String>) —

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

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

  • :lastupdatedfrom (Time) —

    Filters results to any association owners 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 association owners 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:



180
181
182
183
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 180

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

#get_all_association_owners_with_http_info(opts = {}) ⇒ Array<(Array<AssociationOwnerMessage>, Integer, Hash)>

Retrieve all owners Retrieves a list of association owners. &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:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filters results to only records whose name contains the specified value.

  • :phone (String) —

    Filters results to only records whose phone number contains the specified value.

  • :email (String) —

    Filters results to only records whose email contains the specified value.

  • :associationids (Array<Integer>) —

    Filters results to only records that belong to the specified set of association identifiers.

  • :statuses (Array<String>) —

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

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

  • :lastupdatedfrom (Time) —

    Filters results to any association owners 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 association owners 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<AssociationOwnerMessage>, Integer, Hash)>) —

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



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
256
257
258
259
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 201

def get_all_association_owners_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnersApi.get_all_association_owners ...'
  end
  allowable_values = ["Active", "Past", "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
  # resource path
  local_var_path = '/v1/associations/owners'

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

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

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

#get_association_owner_by_id(owner_id, opts = {}) ⇒ AssociationOwnerMessage

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

Parameters:

  • owner_id (Integer) —

    The association owner identifier.

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

    the optional parameters

Returns:



266
267
268
269
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 266

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

#get_association_owner_by_id_with_http_info(owner_id, opts = {}) ⇒ Array<(AssociationOwnerMessage, Integer, Hash)>

Retrieve an owner Retrieve a specific association owner. &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:

  • owner_id (Integer) —

    The association owner identifier.

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

    the optional parameters

Returns:

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

    AssociationOwnerMessage data, response status code and response headers



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

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

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

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

#get_association_owner_note_by_note_id(owner_id, note_id, opts = {}) ⇒ NoteMessage

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

Parameters:

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

    the optional parameters

Returns:



330
331
332
333
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 330

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

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

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

Parameters:

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



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

def get_association_owner_note_by_note_id_with_http_info(owner_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnersApi.get_association_owner_note_by_note_id ...'
  end
  # verify the required parameter 'owner_id' is set
  if @api_client.config.client_side_validation && owner_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_id' when calling AssociationOwnersApi.get_association_owner_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 AssociationOwnersApi.get_association_owner_note_by_note_id"
  end
  # resource path
  local_var_path = '/v1/associations/owners/{ownerId}/notes/{noteId}'.sub('{' + 'ownerId' + '}', CGI.escape(owner_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 => :"AssociationOwnersApi.get_association_owner_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: AssociationOwnersApi#get_association_owner_note_by_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_association_owner_notes(owner_id, opts = {}) ⇒ Array<NoteMessage>

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

Parameters:

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



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

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

#get_association_owner_notes_with_http_info(owner_id, opts = {}) ⇒ Array<(Array<NoteMessage>, Integer, Hash)>

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

Parameters:

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



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
467
468
469
470
471
472
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 420

def get_association_owner_notes_with_http_info(owner_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnersApi.get_association_owner_notes ...'
  end
  # verify the required parameter 'owner_id' is set
  if @api_client.config.client_side_validation && owner_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_id' when calling AssociationOwnersApi.get_association_owner_notes"
  end
  # resource path
  local_var_path = '/v1/associations/owners/{ownerId}/notes'.sub('{' + 'ownerId' + '}', CGI.escape(owner_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 => :"AssociationOwnersApi.get_association_owner_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: AssociationOwnersApi#get_association_owner_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_unit_occupancy_statuses_by_id_for_association_owner(owner_id, unit_id, opts = {}) ⇒ AssociationOwnerUnitOccupancyStatusMessage

Retrieve an occupancy status Retrieves the owner occupancy status for an association unit. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Association owners and tenants</span> - ‘View` <br /><span class="permissionBlock">Associations &gt; Ownership Accounts</span> - `View`

Parameters:

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

    the optional parameters

Returns:



480
481
482
483
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 480

def get_unit_occupancy_statuses_by_id_for_association_owner(owner_id, unit_id, opts = {})
  data, _status_code, _headers = get_unit_occupancy_statuses_by_id_for_association_owner_with_http_info(owner_id, unit_id, opts)
  data
end

#get_unit_occupancy_statuses_by_id_for_association_owner_with_http_info(owner_id, unit_id, opts = {}) ⇒ Array<(AssociationOwnerUnitOccupancyStatusMessage, Integer, Hash)>

Retrieve an occupancy status Retrieves the owner occupancy status for an association unit. &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; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership Accounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 491

def get_unit_occupancy_statuses_by_id_for_association_owner_with_http_info(owner_id, unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnersApi.get_unit_occupancy_statuses_by_id_for_association_owner ...'
  end
  # verify the required parameter 'owner_id' is set
  if @api_client.config.client_side_validation && owner_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_id' when calling AssociationOwnersApi.get_unit_occupancy_statuses_by_id_for_association_owner"
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling AssociationOwnersApi.get_unit_occupancy_statuses_by_id_for_association_owner"
  end
  # resource path
  local_var_path = '/v1/associations/owners/{ownerId}/units/{unitId}'.sub('{' + 'ownerId' + '}', CGI.escape(owner_id.to_s)).sub('{' + 'unitId' + '}', CGI.escape(unit_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] || 'AssociationOwnerUnitOccupancyStatusMessage'

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

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

#get_unit_occupancy_statuses_for_association_owner(owner_id, opts = {}) ⇒ Array<AssociationOwnerUnitOccupancyStatusMessage>

Retrieve all occupancy statuses Retrieves the occupancy status for all of the units owned by the association owner. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Association owners and tenants</span> - ‘View` <br /><span class="permissionBlock">Associations &gt; Ownership Accounts</span> - `View`

Parameters:

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



551
552
553
554
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 551

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

#get_unit_occupancy_statuses_for_association_owner_with_http_info(owner_id, opts = {}) ⇒ Array<(Array<AssociationOwnerUnitOccupancyStatusMessage>, Integer, Hash)>

Retrieve all occupancy statuses Retrieves the occupancy status for all of the units owned by the association owner. &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; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership Accounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 564

def get_unit_occupancy_statuses_for_association_owner_with_http_info(owner_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnersApi.get_unit_occupancy_statuses_for_association_owner ...'
  end
  # verify the required parameter 'owner_id' is set
  if @api_client.config.client_side_validation && owner_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_id' when calling AssociationOwnersApi.get_unit_occupancy_statuses_for_association_owner"
  end
  # resource path
  local_var_path = '/v1/associations/owners/{ownerId}/units'.sub('{' + 'ownerId' + '}', CGI.escape(owner_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<AssociationOwnerUnitOccupancyStatusMessage>'

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

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

#update_association_owner(owner_id, association_owner_put_message, opts = {}) ⇒ AssociationOwnerMessage

Update an owner Updates an existing association owner. <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:

  • owner_id (Integer) —

    The identifier of the association owner to update.

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

    the optional parameters

Returns:



621
622
623
624
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 621

def update_association_owner(owner_id, association_owner_put_message, opts = {})
  data, _status_code, _headers = update_association_owner_with_http_info(owner_id, association_owner_put_message, opts)
  data
end

#update_association_owner_note(owner_id, note_id, note_put_message, opts = {}) ⇒ NoteMessage

Update a note Updates an association owner 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; Association owners and tenants</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



696
697
698
699
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 696

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

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

Update a note Updates an association owner 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; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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



708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 708

def update_association_owner_note_with_http_info(owner_id, note_id, note_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnersApi.update_association_owner_note ...'
  end
  # verify the required parameter 'owner_id' is set
  if @api_client.config.client_side_validation && owner_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_id' when calling AssociationOwnersApi.update_association_owner_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 AssociationOwnersApi.update_association_owner_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 AssociationOwnersApi.update_association_owner_note"
  end
  # resource path
  local_var_path = '/v1/associations/owners/{ownerId}/notes/{noteId}'.sub('{' + 'ownerId' + '}', CGI.escape(owner_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 => :"AssociationOwnersApi.update_association_owner_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: AssociationOwnersApi#update_association_owner_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_association_owner_occupancy_status(owner_id, unit_id, association_owner_unit_occupancy_put_message, opts = {}) ⇒ AssociationOwnerUnitOccupancyStatusMessage

Update occupancy status Updates whether a unit is occupied by the association owner. <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` <br /><span class="permissionBlock">Associations &gt; Ownership Accounts</span> - `View`

Parameters:

Returns:



776
777
778
779
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 776

def update_association_owner_occupancy_status(owner_id, unit_id, association_owner_unit_occupancy_put_message, opts = {})
  data, _status_code, _headers = update_association_owner_occupancy_status_with_http_info(owner_id, unit_id, association_owner_unit_occupancy_put_message, opts)
  data
end

#update_association_owner_occupancy_status_with_http_info(owner_id, unit_id, association_owner_unit_occupancy_put_message, opts = {}) ⇒ Array<(AssociationOwnerUnitOccupancyStatusMessage, Integer, Hash)>

Update occupancy status Updates whether a unit is occupied by the association owner. &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; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership Accounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

Returns:



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 788

def update_association_owner_occupancy_status_with_http_info(owner_id, unit_id, association_owner_unit_occupancy_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnersApi.update_association_owner_occupancy_status ...'
  end
  # verify the required parameter 'owner_id' is set
  if @api_client.config.client_side_validation && owner_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_id' when calling AssociationOwnersApi.update_association_owner_occupancy_status"
  end
  # verify the required parameter 'unit_id' is set
  if @api_client.config.client_side_validation && unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_id' when calling AssociationOwnersApi.update_association_owner_occupancy_status"
  end
  # verify the required parameter 'association_owner_unit_occupancy_put_message' is set
  if @api_client.config.client_side_validation && association_owner_unit_occupancy_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'association_owner_unit_occupancy_put_message' when calling AssociationOwnersApi.update_association_owner_occupancy_status"
  end
  # resource path
  local_var_path = '/v1/associations/owners/{ownerId}/units/{unitId}'.sub('{' + 'ownerId' + '}', CGI.escape(owner_id.to_s)).sub('{' + 'unitId' + '}', CGI.escape(unit_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_owner_unit_occupancy_put_message)

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

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

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

#update_association_owner_with_http_info(owner_id, association_owner_put_message, opts = {}) ⇒ Array<(AssociationOwnerMessage, Integer, Hash)>

Update an owner Updates an existing association owner. &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:

  • owner_id (Integer) —

    The identifier of the association owner to update.

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

    the optional parameters

Returns:

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

    AssociationOwnerMessage data, response status code and response headers



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/buildium-ruby/api/association_owners_api.rb', line 632

def update_association_owner_with_http_info(owner_id, association_owner_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationOwnersApi.update_association_owner ...'
  end
  # verify the required parameter 'owner_id' is set
  if @api_client.config.client_side_validation && owner_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_id' when calling AssociationOwnersApi.update_association_owner"
  end
  # verify the required parameter 'association_owner_put_message' is set
  if @api_client.config.client_side_validation && association_owner_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'association_owner_put_message' when calling AssociationOwnersApi.update_association_owner"
  end
  # resource path
  local_var_path = '/v1/associations/owners/{ownerId}'.sub('{' + 'ownerId' + '}', CGI.escape(owner_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_owner_put_message)

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

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

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