Class: Propertyware::UnitsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UnitsApi

Returns a new instance of UnitsApi.



19
20
21
 
# File 'lib/propertyware/api/units_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/propertyware/api/units_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_contacts_using_post4(save_unit, opts = {}) ⇒ Array<RESTAPIBulkSuccessResponse>

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

Parameters:

  • save_unit (Array<SaveUnit>) —

    saveUnit

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/propertyware/api/units_api.rb', line 27

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

#create_contacts_using_post4_with_http_info(save_unit, opts = {}) ⇒ Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>

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

Parameters:

  • save_unit (Array<SaveUnit>) —

    saveUnit

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

    the optional parameters

Returns:

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

    Array<RESTAPIBulkSuccessResponse> 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/propertyware/api/units_api.rb', line 37

def create_contacts_using_post4_with_http_info(save_unit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnitsApi.create_contacts_using_post4 ...'
  end
  # verify the required parameter 'save_unit' is set
  if @api_client.config.client_side_validation && save_unit.nil?
    fail ArgumentError, "Missing the required parameter 'save_unit' when calling UnitsApi.create_contacts_using_post4"
  end
  # resource path
  local_var_path = '/units/bulk'

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

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

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

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

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

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

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

#create_unit(save_unit, opts = {}) ⇒ Unit

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

Parameters:

  • save_unit (SaveUnit) —

    saveUnit

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/propertyware/api/units_api.rb', line 95

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

#create_unit_with_http_info(save_unit, opts = {}) ⇒ Array<(Unit, Integer, Hash)>

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

Parameters:

  • save_unit (SaveUnit) —

    saveUnit

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

    the optional parameters

Returns:

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

    Unit data, response status code and response headers



105
106
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
 
# File 'lib/propertyware/api/units_api.rb', line 105

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

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

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

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

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

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

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

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

#delete_unit(unit_id, opts = {}) ⇒ ResponseEntity

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

Parameters:

  • unit_id (Integer) —

    Unit ID

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

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/propertyware/api/units_api.rb', line 163

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

#delete_unit_conversation(unit_id, conversation_id, opts = {}) ⇒ ResponseEntity

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

Parameters:

  • unit_id (Integer) —

    Unit ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:



227
228
229
230
 
# File 'lib/propertyware/api/units_api.rb', line 227

def delete_unit_conversation(unit_id, conversation_id, opts = {})
  data, _status_code, _headers = delete_unit_conversation_with_http_info(unit_id, conversation_id, opts)
  data
end

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

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

Parameters:

  • unit_id (Integer) —

    Unit ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:

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

    ResponseEntity data, response status code and response headers



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/propertyware/api/units_api.rb', line 238

def delete_unit_conversation_with_http_info(unit_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnitsApi.delete_unit_conversation ...'
  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 UnitsApi.delete_unit_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling UnitsApi.delete_unit_conversation"
  end
  # resource path
  local_var_path = '/units/{unitID}/conversations/{conversationID}'.sub('{' + 'unitID' + '}', CGI.escape(unit_id.to_s)).sub('{' + 'conversationID' + '}', CGI.escape(conversation_id.to_s))

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

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

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

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

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

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

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

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

#delete_unit_with_http_info(unit_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>

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

Parameters:

  • unit_id (Integer) —

    Unit ID

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

    the optional parameters

Returns:

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

    ResponseEntity data, response status code and response headers



173
174
175
176
177
178
179
180
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
 
# File 'lib/propertyware/api/units_api.rb', line 173

def delete_unit_with_http_info(unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnitsApi.delete_unit ...'
  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 UnitsApi.delete_unit"
  end
  # resource path
  local_var_path = '/units/{unitID}'.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(['*/*'])

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

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

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

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

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

#get_lease_custom_fields_using_get1(unit_id, opts = {}) ⇒ Array<Unit>

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

Parameters:

  • unit_id (Integer) —

    Unit ID

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

    the optional parameters

Returns:



295
296
297
298
 
# File 'lib/propertyware/api/units_api.rb', line 295

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

#get_lease_custom_fields_using_get1_with_http_info(unit_id, opts = {}) ⇒ Array<(Array<Unit>, Integer, Hash)>

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

Parameters:

  • unit_id (Integer) —

    Unit ID

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

    the optional parameters

Returns:

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

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/propertyware/api/units_api.rb', line 305

def get_lease_custom_fields_using_get1_with_http_info(unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnitsApi.get_lease_custom_fields_using_get1 ...'
  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 UnitsApi.get_lease_custom_fields_using_get1"
  end
  # resource path
  local_var_path = '/units/{unitID}/customFields'.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] || 'Array<Unit>'

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

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

#get_unit(unit_id, opts = {}) ⇒ Unit

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

Parameters:

  • unit_id (Integer) —

    Unit ID

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

    the optional parameters

Options Hash (opts):

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to true)

Returns:



359
360
361
362
 
# File 'lib/propertyware/api/units_api.rb', line 359

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

#get_unit_conversation(unit_id, conversation_id, opts = {}) ⇒ Conversation

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

Parameters:

  • unit_id (Integer) —

    Unit ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:



425
426
427
428
 
# File 'lib/propertyware/api/units_api.rb', line 425

def get_unit_conversation(unit_id, conversation_id, opts = {})
  data, _status_code, _headers = get_unit_conversation_with_http_info(unit_id, conversation_id, opts)
  data
end

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

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

Parameters:

  • unit_id (Integer) —

    Unit ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



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
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/propertyware/api/units_api.rb', line 436

def get_unit_conversation_with_http_info(unit_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnitsApi.get_unit_conversation ...'
  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 UnitsApi.get_unit_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling UnitsApi.get_unit_conversation"
  end
  # resource path
  local_var_path = '/units/{unitID}/conversations/{conversationID}'.sub('{' + 'unitID' + '}', CGI.escape(unit_id.to_s)).sub('{' + 'conversationID' + '}', CGI.escape(conversation_id.to_s))

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

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

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

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

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

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

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

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

#get_unit_conversations(unit_id, opts = {}) ⇒ Array<Conversation>

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

Parameters:

  • unit_id (Integer) —

    Unit ID

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

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

  • :last_modified_date_time_start (Time) —

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

  • :last_modified_date_time_end (Time) —

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

  • :orderby (String) —

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

  • :type (String) —

    Filters results by the conversation type.

Returns:



499
500
501
502
 
# File 'lib/propertyware/api/units_api.rb', line 499

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

#get_unit_conversations_with_http_info(unit_id, opts = {}) ⇒ Array<(Array<Conversation>, Integer, Hash)>

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

Parameters:

  • unit_id (Integer) —

    Unit ID

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

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

  • :last_modified_date_time_start (Time) —

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

  • :last_modified_date_time_end (Time) —

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

  • :orderby (String) —

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

  • :type (String) —

    Filters results by the conversation type.

Returns:

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

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



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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/propertyware/api/units_api.rb', line 515

def get_unit_conversations_with_http_info(unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnitsApi.get_unit_conversations ...'
  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 UnitsApi.get_unit_conversations"
  end
  allowable_values = ["MANAGEMENT_TEAM", "OWNER", "TENANT"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/units/{unitID}/conversations'.sub('{' + 'unitID' + '}', CGI.escape(unit_id.to_s))

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

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

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

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

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

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

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

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

#get_unit_with_http_info(unit_id, opts = {}) ⇒ Array<(Unit, Integer, Hash)>

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

Parameters:

  • unit_id (Integer) —

    Unit ID

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

    the optional parameters

Options Hash (opts):

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to true)

Returns:

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

    Unit data, response status code and response headers



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
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/propertyware/api/units_api.rb', line 370

def get_unit_with_http_info(unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnitsApi.get_unit ...'
  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 UnitsApi.get_unit"
  end
  # resource path
  local_var_path = '/units/{unitID}'.sub('{' + 'unitID' + '}', CGI.escape(unit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'includeCustomFields'] = opts[:'include_custom_fields'] if !opts[:'include_custom_fields'].nil?

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

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

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

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

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

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

#get_units(opts = {}) ⇒ Array<Unit>

Retrieve all units Retrieves a list of units.<br/><br/>Required permission:<br/><span class="permissionBlock">UNITS</span> - Read <br/><br/>Sortable by: createddate, idnumber, name, abbreviation, lastmodifieddatetime, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

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

  • :last_modified_date_time_start (Time) —

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

  • :last_modified_date_time_end (Time) —

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

  • :orderby (String) —

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

  • :vacant (Boolean) —

    Filters results by the unit&#39;s vacancy status. If no value is specified, units with any status will be returned.

  • :published_for_rent (Boolean) —

    Filters results by the unit&#39;s &quot;published for rent&quot; status. If no value is specified, units with any status will be returned.

  • :portfolio_id (Integer) —

    Filters results to units associated with a specific portfolio.

  • :building_id (Integer) —

    Filters results to units associated with a specific building.

  • :type (String) —

    Filters results to units with a specific type.

  • :include_deactivated (Boolean) —

    Include inactive units in the results.

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to false)

Returns:



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

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

#get_units_with_http_info(opts = {}) ⇒ Array<(Array<Unit>, Integer, Hash)>

Retrieve all units Retrieves a list of units.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;UNITS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;idnumber&lt;/code&gt;, &lt;code&gt;name&lt;/code&gt;, &lt;code&gt;abbreviation&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

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

  • :last_modified_date_time_start (Time) —

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

  • :last_modified_date_time_end (Time) —

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

  • :orderby (String) —

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

  • :vacant (Boolean) —

    Filters results by the unit&#39;s vacancy status. If no value is specified, units with any status will be returned.

  • :published_for_rent (Boolean) —

    Filters results by the unit&#39;s &quot;published for rent&quot; status. If no value is specified, units with any status will be returned.

  • :portfolio_id (Integer) —

    Filters results to units associated with a specific portfolio.

  • :building_id (Integer) —

    Filters results to units associated with a specific building.

  • :type (String) —

    Filters results to units with a specific type.

  • :include_deactivated (Boolean) —

    Include inactive units in the results.

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to false)

Returns:

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

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



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/propertyware/api/units_api.rb', line 610

def get_units_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnitsApi.get_units ...'
  end
  # resource path
  local_var_path = '/units'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'vacant'] = opts[:'vacant'] if !opts[:'vacant'].nil?
  query_params[:'publishedForRent'] = opts[:'published_for_rent'] if !opts[:'published_for_rent'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'buildingID'] = opts[:'building_id'] if !opts[:'building_id'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'includeDeactivated'] = opts[:'include_deactivated'] if !opts[:'include_deactivated'].nil?
  query_params[:'includeCustomFields'] = opts[:'include_custom_fields'] if !opts[:'include_custom_fields'].nil?

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

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

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

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

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

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

#update_unit(unit_id, save_unit, opts = {}) ⇒ Unit

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

Parameters:

  • unit_id (Integer) —

    Unit ID

  • save_unit (SaveUnit) —

    saveUnit

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

    the optional parameters

Returns:



672
673
674
675
 
# File 'lib/propertyware/api/units_api.rb', line 672

def update_unit(unit_id, save_unit, opts = {})
  data, _status_code, _headers = update_unit_with_http_info(unit_id, save_unit, opts)
  data
end

#update_unit_with_http_info(unit_id, save_unit, opts = {}) ⇒ Array<(Unit, Integer, Hash)>

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

Parameters:

  • unit_id (Integer) —

    Unit ID

  • save_unit (SaveUnit) —

    saveUnit

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

    the optional parameters

Returns:

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

    Unit data, response status code and response headers



683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/propertyware/api/units_api.rb', line 683

def update_unit_with_http_info(unit_id, save_unit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnitsApi.update_unit ...'
  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 UnitsApi.update_unit"
  end
  # verify the required parameter 'save_unit' is set
  if @api_client.config.client_side_validation && save_unit.nil?
    fail ArgumentError, "Missing the required parameter 'save_unit' when calling UnitsApi.update_unit"
  end
  # resource path
  local_var_path = '/units/{unitID}'.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(save_unit)

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

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

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