Class: Propertyware::BuildingsApi
- Inherits:
-
Object
- Object
- Propertyware::BuildingsApi
- Defined in:
- lib/propertyware/api/buildings_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_building(save_building, opts = {}) ⇒ Building
Create a building (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program.
-
#create_building_with_http_info(save_building, opts = {}) ⇒ Array<(Building, Integer, Hash)>
Create a building (BETA) <p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program.
-
#create_contacts(save_building, opts = {}) ⇒ Array<RESTAPIBulkSuccessResponse>
Create buildings in bulk (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program.
-
#create_contacts_with_http_info(save_building, opts = {}) ⇒ Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>
Create buildings in bulk (BETA) <p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program.
-
#delete_building(building_id, opts = {}) ⇒ ResponseEntity
Delete a building (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program.
-
#delete_building_conversation(building_id, conversation_id, opts = {}) ⇒ ResponseEntity
Delete a building conversation (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program.
-
#delete_building_conversation_with_http_info(building_id, conversation_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>
Delete a building conversation (BETA) <p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program.
-
#delete_building_with_http_info(building_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>
Delete a building (BETA) <p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program.
-
#get_building(building_id, opts = {}) ⇒ Building
Retrieve a building Retrieves a specific building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> -
Read
. -
#get_building_conversation(building_id, conversation_id, opts = {}) ⇒ Conversation
Retrieve a building conversation Retrieves a specific building conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> -
Read
. -
#get_building_conversation_with_http_info(building_id, conversation_id, opts = {}) ⇒ Array<(Conversation, Integer, Hash)>
Retrieve a building conversation Retrieves a specific building conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code>.
-
#get_building_conversations(building_id, opts = {}) ⇒ Array<Conversation>
Retrieve all building conversations Retrieves all the conversations of a building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> -
Read
<br/><br/>Sortable by:createddate
,lastmodifieddatetime
,id
. -
#get_building_conversations_with_http_info(building_id, opts = {}) ⇒ Array<(Array<Conversation>, Integer, Hash)>
Retrieve all building conversations Retrieves all the conversations of a building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>.
-
#get_building_management_fee(building_id, opts = {}) ⇒ Array<ManagementFee>
Retrieve all building management fees (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes.
-
#get_building_management_fee_with_http_info(building_id, opts = {}) ⇒ Array<(Array<ManagementFee>, Integer, Hash)>
Retrieve all building management fees (BETA) <p class="betaWarning"><b>Note: </b>This operation is still in beta and might be subject to breaking changes.
-
#get_building_managers(building_id, opts = {}) ⇒ Array<PropertyManager>
Retrieve all building property managers Retrieves all the property managers of a building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> -
Read
. -
#get_building_managers_with_http_info(building_id, opts = {}) ⇒ Array<(Array<PropertyManager>, Integer, Hash)>
Retrieve all building property managers Retrieves all the property managers of a building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code>.
-
#get_building_notes(building_id, opts = {}) ⇒ Array<Note>
Retrieve all building notes Retrieves all the notes of a building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> -
Read
. -
#get_building_notes_with_http_info(building_id, opts = {}) ⇒ Array<(Array<Note>, Integer, Hash)>
Retrieve all building notes Retrieves all the notes of a building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code>.
-
#get_building_with_http_info(building_id, opts = {}) ⇒ Array<(Building, Integer, Hash)>
Retrieve a building Retrieves a specific building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code>.
-
#get_buildings(opts = {}) ⇒ Array<Building>
Retrieve all buildings Retrieves a list of buildings.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> -
Read
<br/><br/>Sortable by:createddate
,idnumber
,name
,abbreviation
,lastmodifieddatetime
,id
. -
#get_buildings_with_http_info(opts = {}) ⇒ Array<(Array<Building>, Integer, Hash)>
Retrieve all buildings Retrieves a list of buildings.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>idnumber</code>, <code>name</code>, <code>abbreviation</code>, <code>lastmodifieddatetime</code>, <code>id</code>.
-
#initialize(api_client = ApiClient.default) ⇒ BuildingsApi
constructor
A new instance of BuildingsApi.
-
#update_building(building_id, save_building, opts = {}) ⇒ Building
Update a building (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program.
-
#update_building_with_http_info(building_id, save_building, opts = {}) ⇒ Array<(Building, Integer, Hash)>
Update a building (BETA) <p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ BuildingsApi
Returns a new instance of BuildingsApi.
19 20 21 |
# File 'lib/propertyware/api/buildings_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/buildings_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_building(save_building, opts = {}) ⇒ Building
Create a building (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 building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Write
27 28 29 30 |
# File 'lib/propertyware/api/buildings_api.rb', line 27 def create_building(save_building, opts = {}) data, _status_code, _headers = create_building_with_http_info(save_building, opts) data end |
#create_building_with_http_info(save_building, opts = {}) ⇒ Array<(Building, Integer, Hash)>
Create a building (BETA) <p class="betaError"><b>Note: </b>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 building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Write</code>
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/buildings_api.rb', line 37 def create_building_with_http_info(save_building, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.create_building ...' end # verify the required parameter 'save_building' is set if @api_client.config.client_side_validation && save_building.nil? fail ArgumentError, "Missing the required parameter 'save_building' when calling BuildingsApi.create_building" end # resource path local_var_path = '/buildings' # 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_building) # return_type return_type = opts[:debug_return_type] || 'Building' # auth_names auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret'] = opts.merge( :operation => :"BuildingsApi.create_building", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#create_building\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_contacts(save_building, opts = {}) ⇒ Array<RESTAPIBulkSuccessResponse>
Create buildings 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 buildings in bulk.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Write
95 96 97 98 |
# File 'lib/propertyware/api/buildings_api.rb', line 95 def create_contacts(save_building, opts = {}) data, _status_code, _headers = create_contacts_with_http_info(save_building, opts) data end |
#create_contacts_with_http_info(save_building, opts = {}) ⇒ Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>
Create buildings in bulk (BETA) <p class="betaError"><b>Note: </b>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 buildings in bulk.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Write</code>
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/buildings_api.rb', line 105 def create_contacts_with_http_info(save_building, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.create_contacts ...' end # verify the required parameter 'save_building' is set if @api_client.config.client_side_validation && save_building.nil? fail ArgumentError, "Missing the required parameter 'save_building' when calling BuildingsApi.create_contacts" end # resource path local_var_path = '/buildings/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_building) # return_type return_type = opts[:debug_return_type] || 'Array<RESTAPIBulkSuccessResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret'] = opts.merge( :operation => :"BuildingsApi.create_contacts", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#create_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_building(building_id, opts = {}) ⇒ ResponseEntity
Delete a building (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> Delete a building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Delete
163 164 165 166 |
# File 'lib/propertyware/api/buildings_api.rb', line 163 def delete_building(building_id, opts = {}) data, _status_code, _headers = delete_building_with_http_info(building_id, opts) data end |
#delete_building_conversation(building_id, conversation_id, opts = {}) ⇒ ResponseEntity
Delete a building 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 building conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Delete
227 228 229 230 |
# File 'lib/propertyware/api/buildings_api.rb', line 227 def delete_building_conversation(building_id, conversation_id, opts = {}) data, _status_code, _headers = delete_building_conversation_with_http_info(building_id, conversation_id, opts) data end |
#delete_building_conversation_with_http_info(building_id, conversation_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>
Delete a building conversation (BETA) <p class="betaError"><b>Note: </b>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 building conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Delete</code>
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/buildings_api.rb', line 238 def delete_building_conversation_with_http_info(building_id, conversation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.delete_building_conversation ...' end # verify the required parameter 'building_id' is set if @api_client.config.client_side_validation && building_id.nil? fail ArgumentError, "Missing the required parameter 'building_id' when calling BuildingsApi.delete_building_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 BuildingsApi.delete_building_conversation" end # resource path local_var_path = '/buildings/{buildingID}/conversations/{conversationID}'.sub('{' + 'buildingID' + '}', CGI.escape(building_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'] = opts.merge( :operation => :"BuildingsApi.delete_building_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#delete_building_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_building_with_http_info(building_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>
Delete a building (BETA) <p class="betaError"><b>Note: </b>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> Delete a building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Delete</code>
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/buildings_api.rb', line 173 def delete_building_with_http_info(building_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.delete_building ...' end # verify the required parameter 'building_id' is set if @api_client.config.client_side_validation && building_id.nil? fail ArgumentError, "Missing the required parameter 'building_id' when calling BuildingsApi.delete_building" end # resource path local_var_path = '/buildings/{buildingID}'.sub('{' + 'buildingID' + '}', CGI.escape(building_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'] = opts.merge( :operation => :"BuildingsApi.delete_building", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#delete_building\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_building(building_id, opts = {}) ⇒ Building
Retrieve a building Retrieves a specific building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Read
296 297 298 299 |
# File 'lib/propertyware/api/buildings_api.rb', line 296 def get_building(building_id, opts = {}) data, _status_code, _headers = get_building_with_http_info(building_id, opts) data end |
#get_building_conversation(building_id, conversation_id, opts = {}) ⇒ Conversation
Retrieve a building conversation Retrieves a specific building conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Read
362 363 364 365 |
# File 'lib/propertyware/api/buildings_api.rb', line 362 def get_building_conversation(building_id, conversation_id, opts = {}) data, _status_code, _headers = get_building_conversation_with_http_info(building_id, conversation_id, opts) data end |
#get_building_conversation_with_http_info(building_id, conversation_id, opts = {}) ⇒ Array<(Conversation, Integer, Hash)>
Retrieve a building conversation Retrieves a specific building conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code>
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 418 419 420 421 422 423 |
# File 'lib/propertyware/api/buildings_api.rb', line 373 def get_building_conversation_with_http_info(building_id, conversation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.get_building_conversation ...' end # verify the required parameter 'building_id' is set if @api_client.config.client_side_validation && building_id.nil? fail ArgumentError, "Missing the required parameter 'building_id' when calling BuildingsApi.get_building_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 BuildingsApi.get_building_conversation" end # resource path local_var_path = '/buildings/{buildingID}/conversations/{conversationID}'.sub('{' + 'buildingID' + '}', CGI.escape(building_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'] = opts.merge( :operation => :"BuildingsApi.get_building_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#get_building_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_building_conversations(building_id, opts = {}) ⇒ Array<Conversation>
Retrieve all building conversations Retrieves all the conversations of a building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Read
<br/><br/>Sortable by: createddate
, lastmodifieddatetime
, id
436 437 438 439 |
# File 'lib/propertyware/api/buildings_api.rb', line 436 def get_building_conversations(building_id, opts = {}) data, _status_code, _headers = get_building_conversations_with_http_info(building_id, opts) data end |
#get_building_conversations_with_http_info(building_id, opts = {}) ⇒ Array<(Array<Conversation>, Integer, Hash)>
Retrieve all building conversations Retrieves all the conversations of a building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
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 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
# File 'lib/propertyware/api/buildings_api.rb', line 452 def get_building_conversations_with_http_info(building_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.get_building_conversations ...' end # verify the required parameter 'building_id' is set if @api_client.config.client_side_validation && building_id.nil? fail ArgumentError, "Missing the required parameter 'building_id' when calling BuildingsApi.get_building_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 = '/buildings/{buildingID}/conversations'.sub('{' + 'buildingID' + '}', CGI.escape(building_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'] = opts.merge( :operation => :"BuildingsApi.get_building_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#get_building_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_building_management_fee(building_id, opts = {}) ⇒ Array<ManagementFee>
Retrieve all building management fees (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves all the management fee rules of a building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Read
515 516 517 518 |
# File 'lib/propertyware/api/buildings_api.rb', line 515 def get_building_management_fee(building_id, opts = {}) data, _status_code, _headers = get_building_management_fee_with_http_info(building_id, opts) data end |
#get_building_management_fee_with_http_info(building_id, opts = {}) ⇒ Array<(Array<ManagementFee>, Integer, Hash)>
Retrieve all building management fees (BETA) <p class="betaWarning"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves all the management fee rules of a building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code>
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/buildings_api.rb', line 525 def get_building_management_fee_with_http_info(building_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.get_building_management_fee ...' end # verify the required parameter 'building_id' is set if @api_client.config.client_side_validation && building_id.nil? fail ArgumentError, "Missing the required parameter 'building_id' when calling BuildingsApi.get_building_management_fee" end # resource path local_var_path = '/buildings/{buildingID}/managementfees'.sub('{' + 'buildingID' + '}', CGI.escape(building_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<ManagementFee>' # auth_names auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret'] = opts.merge( :operation => :"BuildingsApi.get_building_management_fee", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#get_building_management_fee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_building_managers(building_id, opts = {}) ⇒ Array<PropertyManager>
Retrieve all building property managers Retrieves all the property managers of a building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Read
578 579 580 581 |
# File 'lib/propertyware/api/buildings_api.rb', line 578 def get_building_managers(building_id, opts = {}) data, _status_code, _headers = get_building_managers_with_http_info(building_id, opts) data end |
#get_building_managers_with_http_info(building_id, opts = {}) ⇒ Array<(Array<PropertyManager>, Integer, Hash)>
Retrieve all building property managers Retrieves all the property managers of a building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code>
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 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
# File 'lib/propertyware/api/buildings_api.rb', line 588 def get_building_managers_with_http_info(building_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.get_building_managers ...' end # verify the required parameter 'building_id' is set if @api_client.config.client_side_validation && building_id.nil? fail ArgumentError, "Missing the required parameter 'building_id' when calling BuildingsApi.get_building_managers" end # resource path local_var_path = '/buildings/{buildingID}/managers'.sub('{' + 'buildingID' + '}', CGI.escape(building_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<PropertyManager>' # auth_names auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret'] = opts.merge( :operation => :"BuildingsApi.get_building_managers", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#get_building_managers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_building_notes(building_id, opts = {}) ⇒ Array<Note>
Retrieve all building notes Retrieves all the notes of a building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Read
641 642 643 644 |
# File 'lib/propertyware/api/buildings_api.rb', line 641 def get_building_notes(building_id, opts = {}) data, _status_code, _headers = get_building_notes_with_http_info(building_id, opts) data end |
#get_building_notes_with_http_info(building_id, opts = {}) ⇒ Array<(Array<Note>, Integer, Hash)>
Retrieve all building notes Retrieves all the notes of a building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code>
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 688 689 690 691 692 693 694 695 696 697 |
# File 'lib/propertyware/api/buildings_api.rb', line 651 def get_building_notes_with_http_info(building_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.get_building_notes ...' end # verify the required parameter 'building_id' is set if @api_client.config.client_side_validation && building_id.nil? fail ArgumentError, "Missing the required parameter 'building_id' when calling BuildingsApi.get_building_notes" end # resource path local_var_path = '/buildings/{buildingID}/notes'.sub('{' + 'buildingID' + '}', CGI.escape(building_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<Note>' # auth_names auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret'] = opts.merge( :operation => :"BuildingsApi.get_building_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#get_building_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_building_with_http_info(building_id, opts = {}) ⇒ Array<(Building, Integer, Hash)>
Retrieve a building Retrieves a specific building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code>
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 352 353 354 |
# File 'lib/propertyware/api/buildings_api.rb', line 307 def get_building_with_http_info(building_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.get_building ...' end # verify the required parameter 'building_id' is set if @api_client.config.client_side_validation && building_id.nil? fail ArgumentError, "Missing the required parameter 'building_id' when calling BuildingsApi.get_building" end # resource path local_var_path = '/buildings/{buildingID}'.sub('{' + 'buildingID' + '}', CGI.escape(building_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] || 'Building' # auth_names auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret'] = opts.merge( :operation => :"BuildingsApi.get_building", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#get_building\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_buildings(opts = {}) ⇒ Array<Building>
Retrieve all buildings Retrieves a list of buildings.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Read
<br/><br/>Sortable by: createddate
, idnumber
, name
, abbreviation
, lastmodifieddatetime
, id
714 715 716 717 |
# File 'lib/propertyware/api/buildings_api.rb', line 714 def get_buildings(opts = {}) data, _status_code, _headers = get_buildings_with_http_info(opts) data end |
#get_buildings_with_http_info(opts = {}) ⇒ Array<(Array<Building>, Integer, Hash)>
Retrieve all buildings Retrieves a list of buildings.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>idnumber</code>, <code>name</code>, <code>abbreviation</code>, <code>lastmodifieddatetime</code>, <code>id</code>
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 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 |
# File 'lib/propertyware/api/buildings_api.rb', line 734 def get_buildings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.get_buildings ...' end # resource path local_var_path = '/buildings' # 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[:'leaseID'] = opts[:'lease_id'] if !opts[:'lease_id'].nil? query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].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<Building>' # auth_names auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret'] = opts.merge( :operation => :"BuildingsApi.get_buildings", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#get_buildings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_building(building_id, save_building, opts = {}) ⇒ Building
Update a building (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> Updates a building.<br/><br/>Required permission:<br/><span class="permissionBlock">BUILDINGS</span> - Write
795 796 797 798 |
# File 'lib/propertyware/api/buildings_api.rb', line 795 def update_building(building_id, save_building, opts = {}) data, _status_code, _headers = update_building_with_http_info(building_id, save_building, opts) data end |
#update_building_with_http_info(building_id, save_building, opts = {}) ⇒ Array<(Building, Integer, Hash)>
Update a building (BETA) <p class="betaError"><b>Note: </b>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> Updates a building.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">BUILDINGS</span> - <code>Write</code>
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 848 849 850 851 852 853 854 855 856 857 858 859 860 861 |
# File 'lib/propertyware/api/buildings_api.rb', line 806 def update_building_with_http_info(building_id, save_building, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BuildingsApi.update_building ...' end # verify the required parameter 'building_id' is set if @api_client.config.client_side_validation && building_id.nil? fail ArgumentError, "Missing the required parameter 'building_id' when calling BuildingsApi.update_building" end # verify the required parameter 'save_building' is set if @api_client.config.client_side_validation && save_building.nil? fail ArgumentError, "Missing the required parameter 'save_building' when calling BuildingsApi.update_building" end # resource path local_var_path = '/buildings/{buildingID}'.sub('{' + 'buildingID' + '}', CGI.escape(building_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_building) # return_type return_type = opts[:debug_return_type] || 'Building' # auth_names auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret'] = opts.merge( :operation => :"BuildingsApi.update_building", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BuildingsApi#update_building\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |