Class: Buildium::ListingsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ListingsApi

Returns a new instance of ListingsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_listing_contact(listing_contact_save_message, opts = {}) ⇒ ListingContactMessage

Create a listing contact Create a listing contact. Note, at least one contact field (phone number, email or website) is required for the listing contact. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Listings</span> - ‘View` `Edit`

Parameters:

Returns:



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

def create_listing_contact(listing_contact_save_message, opts = {})
  data, _status_code, _headers = create_listing_contact_with_http_info(listing_contact_save_message, opts)
  data
end

#create_listing_contact_with_http_info(listing_contact_save_message, opts = {}) ⇒ Array<(ListingContactMessage, Integer, Hash)>

Create a listing contact Create a listing contact. Note, at least one contact field (phone number, email or website) is required for the listing contact. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Listings&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:

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

    ListingContactMessage 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/listings_api.rb', line 37

def create_listing_contact_with_http_info(listing_contact_save_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListingsApi.create_listing_contact ...'
  end
  # verify the required parameter 'listing_contact_save_message' is set
  if @api_client.config.client_side_validation && listing_contact_save_message.nil?
    fail ArgumentError, "Missing the required parameter 'listing_contact_save_message' when calling ListingsApi.create_listing_contact"
  end
  # resource path
  local_var_path = '/v1/rentals/units/listingcontacts'

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

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

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

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

#delist_unit(unit_id, opts = {}) ⇒ nil

Delete a listing Deleting a listing will immediately remove it from your Buildium public website. The listing will also be removed from any syndicated sites within 24-48 hours.<br /><br />Listings manually created on craigslist using the Buildium guided tool will not be removed. The listing must be removed using craigslist’s tools provided in your craigslist account. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Listings</span> - ‘View` `Edit` `Delete`

Parameters:

  • unit_id (Integer) —

    The rental property unit identifier.

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

    the optional parameters

Returns:

  • (nil) 


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

def delist_unit(unit_id, opts = {})
  delist_unit_with_http_info(unit_id, opts)
  nil
end

#delist_unit_with_http_info(unit_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a listing Deleting a listing will immediately remove it from your Buildium public website. The listing will also be removed from any syndicated sites within 24-48 hours.&lt;br /&gt;&lt;br /&gt;Listings manually created on craigslist using the Buildium guided tool will not be removed. The listing must be removed using craigslist&#39;s tools provided in your craigslist account. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Listings&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &#x60;Delete&#x60;

Parameters:

  • unit_id (Integer) —

    The rental property unit identifier.

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

    the optional parameters

Returns:

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

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

def delist_unit_with_http_info(unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListingsApi.delist_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 ListingsApi.delist_unit"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}/listing'.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]

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

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

#get_all_listing_contacts(opts = {}) ⇒ Array<ListingContactMessage>

Retrieve all listing contacts Retrieves all listing contacts. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Listings</span> - ‘View`

Parameters:

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



160
161
162
163
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 160

def get_all_listing_contacts(opts = {})
  data, _status_code, _headers = get_all_listing_contacts_with_http_info(opts)
  data
end

#get_all_listing_contacts_with_http_info(opts = {}) ⇒ Array<(Array<ListingContactMessage>, Integer, Hash)>

Retrieve all listing contacts Retrieves all listing contacts. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Listings&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

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

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



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

def get_all_listing_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListingsApi.get_all_listing_contacts ...'
  end
  # resource path
  local_var_path = '/v1/rentals/units/listingcontacts'

  # 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<ListingContactMessage>'

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

  new_options = opts.merge(
    :operation => :"ListingsApi.get_all_listing_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ListingsApi#get_all_listing_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_listing_contact_by_id(listing_contact_id, opts = {}) ⇒ ListingContactMessage

Retrieve a listing contact Retrieves a specific listing contact. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Listings</span> - ‘View`

Parameters:

  • listing_contact_id (Integer) —

    The listing contact identifier.

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

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 224

def get_listing_contact_by_id(listing_contact_id, opts = {})
  data, _status_code, _headers = get_listing_contact_by_id_with_http_info(listing_contact_id, opts)
  data
end

#get_listing_contact_by_id_with_http_info(listing_contact_id, opts = {}) ⇒ Array<(ListingContactMessage, Integer, Hash)>

Retrieve a listing contact Retrieves a specific listing contact. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Listings&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • listing_contact_id (Integer) —

    The listing contact identifier.

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

    the optional parameters

Returns:

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

    ListingContactMessage data, response status code and response headers



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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 234

def get_listing_contact_by_id_with_http_info(listing_contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListingsApi.get_listing_contact_by_id ...'
  end
  # verify the required parameter 'listing_contact_id' is set
  if @api_client.config.client_side_validation && listing_contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'listing_contact_id' when calling ListingsApi.get_listing_contact_by_id"
  end
  # resource path
  local_var_path = '/v1/rentals/units/listingcontacts/{listingContactId}'.sub('{' + 'listingContactId' + '}', CGI.escape(listing_contact_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] || 'ListingContactMessage'

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

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

#get_listing_for_unit_async(unit_id, opts = {}) ⇒ ListingMessage

Retrieve a listing Retrieves a specific listing. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Rentals &gt; Listings</span> - ‘View` <br /><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - `View`

Parameters:

  • unit_id (Integer) —

    The rental unit identifier.

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

    the optional parameters

Returns:



287
288
289
290
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 287

def get_listing_for_unit_async(unit_id, opts = {})
  data, _status_code, _headers = get_listing_for_unit_async_with_http_info(unit_id, opts)
  data
end

#get_listing_for_unit_async_with_http_info(unit_id, opts = {}) ⇒ Array<(ListingMessage, Integer, Hash)>

Retrieve a listing Retrieves a specific listing. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Listings&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • unit_id (Integer) —

    The rental unit identifier.

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

    the optional parameters

Returns:

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

    ListingMessage data, response status code and response headers



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 297

def get_listing_for_unit_async_with_http_info(unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListingsApi.get_listing_for_unit_async ...'
  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 ListingsApi.get_listing_for_unit_async"
  end
  # resource path
  local_var_path = '/v1/rentals/units/{unitId}/listing'.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] || 'ListingMessage'

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

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

#get_listings_async(opts = {}) ⇒ Array<ListingMessage>

Retrieve all listings Retrieves all listings. <br /><br /><span class="permissionBlock">Rentals &gt; Listings</span> - ‘View` <br /><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - `View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :entitytype (String) —

    Specifies the type of entity that &#x60;EntityId&#x60; refers to.

  • :entityid (Integer) —

    Filters results to only listings that are associated with the specified entity id value. The id must be of the type specified in &#x60;EntityType&#x60; property.

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



354
355
356
357
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 354

def get_listings_async(opts = {})
  data, _status_code, _headers = get_listings_async_with_http_info(opts)
  data
end

#get_listings_async_with_http_info(opts = {}) ⇒ Array<(Array<ListingMessage>, Integer, Hash)>

Retrieve all listings Retrieves all listings. &lt;br /&gt;&lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Listings&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :entitytype (String) —

    Specifies the type of entity that &#x60;EntityId&#x60; refers to.

  • :entityid (Integer) —

    Filters results to only listings that are associated with the specified entity id value. The id must be of the type specified in &#x60;EntityType&#x60; property.

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

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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 368

def get_listings_async_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListingsApi.get_listings_async ...'
  end
  allowable_values = ["Property", "RentalOwner"]
  if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
    fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/rentals/units/listings'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
  query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].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<ListingMessage>'

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

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

#update_listing_contact(listing_contact_id, listing_contact_save_message, opts = {}) ⇒ ListingContactMessage

Update a listing contact Update a listing contact. Note, at least one contact field (phone number, email or website) is required for the listing contact. <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">Rentals &gt; Listings</span> - ‘View` `Edit`

Parameters:

  • listing_contact_id (Integer) —

    The listing contact identifier.

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

    the optional parameters

Returns:



427
428
429
430
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 427

def update_listing_contact(listing_contact_id, listing_contact_save_message, opts = {})
  data, _status_code, _headers = update_listing_contact_with_http_info(listing_contact_id, listing_contact_save_message, opts)
  data
end

#update_listing_contact_with_http_info(listing_contact_id, listing_contact_save_message, opts = {}) ⇒ Array<(ListingContactMessage, Integer, Hash)>

Update a listing contact Update a listing contact. Note, at least one contact field (phone number, email or website) is required for the listing contact. &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;Rentals &amp;gt; Listings&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • listing_contact_id (Integer) —

    The listing contact identifier.

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

    the optional parameters

Returns:

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

    ListingContactMessage data, response status code and response headers



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
487
488
489
490
491
492
493
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 438

def update_listing_contact_with_http_info(listing_contact_id, listing_contact_save_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListingsApi.update_listing_contact ...'
  end
  # verify the required parameter 'listing_contact_id' is set
  if @api_client.config.client_side_validation && listing_contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'listing_contact_id' when calling ListingsApi.update_listing_contact"
  end
  # verify the required parameter 'listing_contact_save_message' is set
  if @api_client.config.client_side_validation && listing_contact_save_message.nil?
    fail ArgumentError, "Missing the required parameter 'listing_contact_save_message' when calling ListingsApi.update_listing_contact"
  end
  # resource path
  local_var_path = '/v1/rentals/units/listingcontacts/{listingContactId}'.sub('{' + 'listingContactId' + '}', CGI.escape(listing_contact_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(listing_contact_save_message)

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

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

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

#upsert_listings_async(unit_id, listing_put_message, opts = {}) ⇒ ListingMessage

Create/Update a listing This endpoint can be used to both create and update a listing. If no listing exists for the unit one will be created, otherwise the existing listing will be updated. A unit can only ever have one active listing. <br /><br /> Upon creation the listing will post immediately to your Buildium public website, and will post to the selected syndicated sites within 24-48 hours. Updates to the listing will appear immediately in your Buildium public website and propagated to syndicated sites within 24-48 hours. <br /><br /> Note, the listing will automatically pull in the information, features, and media that exists for the property and unit details. <br /><br /><span class="permissionBlock">Rentals &gt; Listings</span> - ‘View` `Edit` <br /><span class="permissionBlock">Rentals &gt; Rental properties and units</span> - `View` `Edit`

Parameters:

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

    the optional parameters

Returns:



501
502
503
504
 
# File 'lib/buildium-ruby/api/listings_api.rb', line 501

def upsert_listings_async(unit_id, listing_put_message, opts = {})
  data, _status_code, _headers = upsert_listings_async_with_http_info(unit_id, listing_put_message, opts)
  data
end

#upsert_listings_async_with_http_info(unit_id, listing_put_message, opts = {}) ⇒ Array<(ListingMessage, Integer, Hash)>

Create/Update a listing This endpoint can be used to both create and update a listing. If no listing exists for the unit one will be created, otherwise the existing listing will be updated. A unit can only ever have one active listing. &lt;br /&gt;&lt;br /&gt; Upon creation the listing will post immediately to your Buildium public website, and will post to the selected syndicated sites within 24-48 hours. Updates to the listing will appear immediately in your Buildium public website and propagated to syndicated sites within 24-48 hours. &lt;br /&gt;&lt;br /&gt; Note, the listing will automatically pull in the information, features, and media that exists for the property and unit details. &lt;br /&gt;&lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Listings&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Rental properties and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    ListingMessage data, response status code and response headers



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

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

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

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

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