Class: Buildium::CommunicationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CommunicationsApi

Returns a new instance of CommunicationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_announcement(announcement_post_message, opts = {}) ⇒ AnnouncementMessage

Create an announcement Creates and publishes an announcement. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Announcements</span> - ‘View` `Edit`

Parameters:

Returns:



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

def create_announcement(announcement_post_message, opts = {})
  data, _status_code, _headers = create_announcement_with_http_info(announcement_post_message, opts)
  data
end

#create_announcement_with_http_info(announcement_post_message, opts = {}) ⇒ Array<(AnnouncementMessage, Integer, Hash)>

Create an announcement Creates and publishes an announcement. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Announcements&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:

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

    AnnouncementMessage 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/communications_api.rb', line 37

def create_announcement_with_http_info(announcement_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.create_announcement ...'
  end
  # verify the required parameter 'announcement_post_message' is set
  if @api_client.config.client_side_validation && announcement_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'announcement_post_message' when calling CommunicationsApi.create_announcement"
  end
  # resource path
  local_var_path = '/v1/communications/announcements'

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

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

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

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

#create_phone_log(phone_log_post_message, opts = {}) ⇒ PhoneLogMessage

Create a phone log Creates a phone log. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Timelines (Phone Logs)</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



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

def create_phone_log(phone_log_post_message, opts = {})
  data, _status_code, _headers = create_phone_log_with_http_info(phone_log_post_message, opts)
  data
end

#create_phone_log_with_http_info(phone_log_post_message, opts = {}) ⇒ Array<(PhoneLogMessage, Integer, Hash)>

Create a phone log Creates a phone log. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Timelines (Phone Logs)&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    PhoneLogMessage 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/buildium-ruby/api/communications_api.rb', line 105

def create_phone_log_with_http_info(phone_log_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.create_phone_log ...'
  end
  # verify the required parameter 'phone_log_post_message' is set
  if @api_client.config.client_side_validation && phone_log_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'phone_log_post_message' when calling CommunicationsApi.create_phone_log"
  end
  # resource path
  local_var_path = '/v1/communications/phonelogs'

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

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

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

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

#emails_external_api_write_create_email(email_post_message, opts = {}) ⇒ nil

Create an email. Creates an email <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communication &gt; Emails</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


163
164
165
166
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 163

def emails_external_api_write_create_email(email_post_message, opts = {})
  emails_external_api_write_create_email_with_http_info(email_post_message, opts)
  nil
end

#emails_external_api_write_create_email_with_http_info(email_post_message, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create an email. Creates an email &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communication &amp;gt; Emails&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
220
221
222
223
224
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 173

def emails_external_api_write_create_email_with_http_info(email_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.emails_external_api_write_create_email ...'
  end
  # verify the required parameter 'email_post_message' is set
  if @api_client.config.client_side_validation && email_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'email_post_message' when calling CommunicationsApi.emails_external_api_write_create_email"
  end
  # resource path
  local_var_path = '/v1/communications/emails'

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#expire_announcement(announcement_id, opts = {}) ⇒ nil

Expire an announcement Removes the announcement from the Resident Center immediately. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Announcements</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


231
232
233
234
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 231

def expire_announcement(announcement_id, opts = {})
  expire_announcement_with_http_info(announcement_id, opts)
  nil
end

#expire_announcement_with_http_info(announcement_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Expire an announcement Removes the announcement from the Resident Center immediately. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Announcements&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def expire_announcement_with_http_info(announcement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.expire_announcement ...'
  end
  # verify the required parameter 'announcement_id' is set
  if @api_client.config.client_side_validation && announcement_id.nil?
    fail ArgumentError, "Missing the required parameter 'announcement_id' when calling CommunicationsApi.expire_announcement"
  end
  # resource path
  local_var_path = '/v1/communications/announcements/{announcementId}/expirationrequest'.sub('{' + 'announcementId' + '}', CGI.escape(announcement_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 => :"CommunicationsApi.expire_announcement",
    :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: CommunicationsApi#expire_announcement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_announcements(opts = {}) ⇒ Array<AnnouncementMessage>

Retrieve all announcements Retrieves all announcements. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Announcements</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :announcementdatefrom (Date) —

    Filters results to any announcements created on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • :announcementdateto (Date) —

    Filters results to any announcements created on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • :entityid (Integer) —

    Filters results to any announcement associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.

  • :entitytype (String) —

    Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is provided.

  • :senderid (Integer) —

    Unique identifier of the user that published the announcement.

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



301
302
303
304
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 301

def get_all_announcements(opts = {})
  data, _status_code, _headers = get_all_announcements_with_http_info(opts)
  data
end

#get_all_announcements_with_http_info(opts = {}) ⇒ Array<(Array<AnnouncementMessage>, Integer, Hash)>

Retrieve all announcements Retrieves all announcements. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Announcements&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :announcementdatefrom (Date) —

    Filters results to any announcements created on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • :announcementdateto (Date) —

    Filters results to any announcements created on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • :entityid (Integer) —

    Filters results to any announcement associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.

  • :entitytype (String) —

    Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is provided.

  • :senderid (Integer) —

    Unique identifier of the user that published the announcement.

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

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



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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 318

def get_all_announcements_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_all_announcements ...'
  end
  allowable_values = ["Rental", "RentalOwner", "Association"]
  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/communications/announcements'

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

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

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

#get_announcement_by_id(announcement_id, opts = {}) ⇒ AnnouncementMessage

Retrieve an announcement Retrieves an announcement. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Announcements</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



379
380
381
382
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 379

def get_announcement_by_id(announcement_id, opts = {})
  data, _status_code, _headers = get_announcement_by_id_with_http_info(announcement_id, opts)
  data
end

#get_announcement_by_id_with_http_info(announcement_id, opts = {}) ⇒ Array<(AnnouncementMessage, Integer, Hash)>

Retrieve an announcement Retrieves an announcement. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Announcements&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    AnnouncementMessage data, response status code and response headers



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
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 389

def get_announcement_by_id_with_http_info(announcement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_announcement_by_id ...'
  end
  # verify the required parameter 'announcement_id' is set
  if @api_client.config.client_side_validation && announcement_id.nil?
    fail ArgumentError, "Missing the required parameter 'announcement_id' when calling CommunicationsApi.get_announcement_by_id"
  end
  # resource path
  local_var_path = '/v1/communications/announcements/{announcementId}'.sub('{' + 'announcementId' + '}', CGI.escape(announcement_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] || 'AnnouncementMessage'

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

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

#get_announcement_properties(announcement_id, opts = {}) ⇒ Array<PropertyMessage>

Retrieve all announcement properties Retrieves a list of association and/or rental properties whose residents received the announcement. An empty response collection indicates that the announcement was sent to all properties at the time of its creation. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Announcements</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



445
446
447
448
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 445

def get_announcement_properties(announcement_id, opts = {})
  data, _status_code, _headers = get_announcement_properties_with_http_info(announcement_id, opts)
  data
end

#get_announcement_properties_with_http_info(announcement_id, opts = {}) ⇒ Array<(Array<PropertyMessage>, Integer, Hash)>

Retrieve all announcement properties Retrieves a list of association and/or rental properties whose residents received the announcement. An empty response collection indicates that the announcement was sent to all properties at the time of its creation. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Announcements&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:

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

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



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

def get_announcement_properties_with_http_info(announcement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_announcement_properties ...'
  end
  # verify the required parameter 'announcement_id' is set
  if @api_client.config.client_side_validation && announcement_id.nil?
    fail ArgumentError, "Missing the required parameter 'announcement_id' when calling CommunicationsApi.get_announcement_properties"
  end
  # resource path
  local_var_path = '/v1/communications/announcements/{announcementId}/properties'.sub('{' + 'announcementId' + '}', CGI.escape(announcement_id.to_s))

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

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

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

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

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

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

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

#get_email_by_id(email_id, opts = {}) ⇒ EmailMessage

Retrieve an email Retrieves an email. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Emails</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



514
515
516
517
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 514

def get_email_by_id(email_id, opts = {})
  data, _status_code, _headers = get_email_by_id_with_http_info(email_id, opts)
  data
end

#get_email_by_id_with_http_info(email_id, opts = {}) ⇒ Array<(EmailMessage, Integer, Hash)>

Retrieve an email Retrieves an email. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Emails&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



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

def get_email_by_id_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_email_by_id ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling CommunicationsApi.get_email_by_id"
  end
  # resource path
  local_var_path = '/v1/communications/emails/{emailId}'.sub('{' + 'emailId' + '}', CGI.escape(email_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] || 'EmailMessage'

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

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

#get_email_recipients(email_id, opts = {}) ⇒ Array<EmailRecipientMessage>

Retrieve all email recipients Retrieves all email recipients. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Email</span> - ‘View` <br /><h4>Optional Permissions:</h4><br /> The following permissions are optional, but results with a missing permission will be filtered out. <span class="permissionBlock">Maintenance &gt; Vendors</span> - `View` In order to retrieve recipients that are Vendors, you must have this permission. <span class="permissionBlock">Administration &gt; Users</span> - `View` In order to see recipients that are Staff, you must have this permission.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



580
581
582
583
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 580

def get_email_recipients(email_id, opts = {})
  data, _status_code, _headers = get_email_recipients_with_http_info(email_id, opts)
  data
end

#get_email_recipients_with_http_info(email_id, opts = {}) ⇒ Array<(Array<EmailRecipientMessage>, Integer, Hash)>

Retrieve all email recipients Retrieves all email recipients. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Email&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;h4&gt;Optional Permissions:&lt;/h4&gt;&lt;br /&gt; The following permissions are optional, but results with a missing permission will be filtered out. &lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Maintenance &amp;gt; Vendors&lt;/span&gt; - &#x60;View&#x60; In order to retrieve recipients that are Vendors, you must have this permission. &lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Administration &amp;gt; Users&lt;/span&gt; - &#x60;View&#x60; In order to see recipients that are Staff, you must have this permission.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:

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

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



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
635
636
637
638
639
640
641
642
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 593

def get_email_recipients_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_email_recipients ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling CommunicationsApi.get_email_recipients"
  end
  # resource path
  local_var_path = '/v1/communications/emails/{emailId}/recipients'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

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

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

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

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

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

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

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

#get_emails(sentdatetimefrom, sentdatetimeto, opts = {}) ⇒ Array<EmailMessage>

Retrieve all emails Retrieves all emails. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communication &gt; Emails</span> - ‘View`

Parameters:

  • sentdatetimefrom (Time) —

    Filters results to any emails whose sent date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DDTHH:MM:SSZ. The maximum date range is 90 days.

  • sentdatetimeto (Time) —

    Filters results to any emails whose sent date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DDTHH:MM:SSZ. The maximum date range is 90 days.

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

    the optional parameters

Options Hash (opts):

  • :subject (String) —

    Filters results to any email whose subject contains the specified value.

  • :recipientnameoremail (String) —

    Filters results to any email with a recipient whose name or email address contains the specified value.

  • :senderuserid (Integer) —

    Filters results to only emails that were sent by the specified user identifier.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:



656
657
658
659
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 656

def get_emails(sentdatetimefrom, sentdatetimeto, opts = {})
  data, _status_code, _headers = get_emails_with_http_info(sentdatetimefrom, sentdatetimeto, opts)
  data
end

#get_emails_with_http_info(sentdatetimefrom, sentdatetimeto, opts = {}) ⇒ Array<(Array<EmailMessage>, Integer, Hash)>

Retrieve all emails Retrieves all emails. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communication &amp;gt; Emails&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • sentdatetimefrom (Time) —

    Filters results to any emails whose sent date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DDTHH:MM:SSZ. The maximum date range is 90 days.

  • sentdatetimeto (Time) —

    Filters results to any emails whose sent date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DDTHH:MM:SSZ. The maximum date range is 90 days.

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

    the optional parameters

Options Hash (opts):

  • :subject (String) —

    Filters results to any email whose subject contains the specified value.

  • :recipientnameoremail (String) —

    Filters results to any email with a recipient whose name or email address contains the specified value.

  • :senderuserid (Integer) —

    Filters results to only emails that were sent by the specified user identifier.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

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

  • :limit (Integer) —

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

Returns:

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

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



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

def get_emails_with_http_info(sentdatetimefrom, sentdatetimeto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_emails ...'
  end
  # verify the required parameter 'sentdatetimefrom' is set
  if @api_client.config.client_side_validation && sentdatetimefrom.nil?
    fail ArgumentError, "Missing the required parameter 'sentdatetimefrom' when calling CommunicationsApi.get_emails"
  end
  # verify the required parameter 'sentdatetimeto' is set
  if @api_client.config.client_side_validation && sentdatetimeto.nil?
    fail ArgumentError, "Missing the required parameter 'sentdatetimeto' when calling CommunicationsApi.get_emails"
  end
  # resource path
  local_var_path = '/v1/communications/emails'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sentdatetimefrom'] = sentdatetimefrom
  query_params[:'sentdatetimeto'] = sentdatetimeto
  query_params[:'subject'] = opts[:'subject'] if !opts[:'subject'].nil?
  query_params[:'recipientnameoremail'] = opts[:'recipientnameoremail'] if !opts[:'recipientnameoremail'].nil?
  query_params[:'senderuserid'] = opts[:'senderuserid'] if !opts[:'senderuserid'].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<EmailMessage>'

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

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

#get_mailing_templates(opts = {}) ⇒ Array<MailingTemplateMessage>

Retrieve all communication templates Retrieves all mailing and email templates. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Mailing Templates</span> - ‘View` <br /><h4>Optional Permissions:</h4><span class="permissionBlock">Rentals &gt; Tenants</span> - `View` <br /><span class="permissionBlock">Rentals &gt; Property Rental owners</span> - `View` <br /><span class="permissionBlock">Associations &gt; Association owners and tenants</span> - `View` <br /><span class="permissionBlock">Maintenance &gt; Vendors</span> - `View` <br /><span class="permissionBlock">Rentals &gt; Applicants</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:



740
741
742
743
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 740

def get_mailing_templates(opts = {})
  data, _status_code, _headers = get_mailing_templates_with_http_info(opts)
  data
end

#get_mailing_templates_by_id(template_id, opts = {}) ⇒ MailingTemplateMessage

Retrieve a communication template Retrieves a communication template. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Mailing Templates</span> - ‘View` <br /><h4>Optional Permissions:</h4><span class="permissionBlock">Rentals &gt; Tenants</span> - `View` <br /><span class="permissionBlock">Rentals &gt; Property Rental owners</span> - `View` <br /><span class="permissionBlock">Associations &gt; Association owners and tenants</span> - `View` <br /><span class="permissionBlock">Maintenance &gt; Vendors</span> - `View` <br /><span class="permissionBlock">Rentals &gt; Applicants</span> - `View`

Parameters:

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

    the optional parameters

Returns:



804
805
806
807
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 804

def get_mailing_templates_by_id(template_id, opts = {})
  data, _status_code, _headers = get_mailing_templates_by_id_with_http_info(template_id, opts)
  data
end

#get_mailing_templates_by_id_with_http_info(template_id, opts = {}) ⇒ Array<(MailingTemplateMessage, Integer, Hash)>

Retrieve a communication template Retrieves a communication template. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Mailing Templates&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;h4&gt;Optional Permissions:&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Tenants&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Property Rental owners&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Maintenance &amp;gt; Vendors&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    MailingTemplateMessage data, response status code and response headers



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

def get_mailing_templates_by_id_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_mailing_templates_by_id ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling CommunicationsApi.get_mailing_templates_by_id"
  end
  # resource path
  local_var_path = '/v1/communications/templates/{templateId}'.sub('{' + 'templateId' + '}', CGI.escape(template_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] || 'MailingTemplateMessage'

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

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

#get_mailing_templates_with_http_info(opts = {}) ⇒ Array<(Array<MailingTemplateMessage>, Integer, Hash)>

Retrieve all communication templates Retrieves all mailing and email templates. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Mailing Templates&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;h4&gt;Optional Permissions:&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Tenants&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Property Rental owners&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Maintenance &amp;gt; Vendors&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Rentals &amp;gt; Applicants&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<MailingTemplateMessage>, Integer, Hash)>) —

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



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
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 752

def get_mailing_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_mailing_templates ...'
  end
  # resource path
  local_var_path = '/v1/communications/templates'

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

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

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

#get_phone_log_by_id(phone_log_id, opts = {}) ⇒ PhoneLogMessage

Retrieve a phone log Retrieves a specific phone log. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Timelines (Phone Logs)</span> - ‘View`

Parameters:

  • phone_log_id (Integer) —

    The phone log identifier

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

    the optional parameters

Returns:



867
868
869
870
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 867

def get_phone_log_by_id(phone_log_id, opts = {})
  data, _status_code, _headers = get_phone_log_by_id_with_http_info(phone_log_id, opts)
  data
end

#get_phone_log_by_id_with_http_info(phone_log_id, opts = {}) ⇒ Array<(PhoneLogMessage, Integer, Hash)>

Retrieve a phone log Retrieves a specific phone log. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Timelines (Phone Logs)&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • phone_log_id (Integer) —

    The phone log identifier

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

    the optional parameters

Returns:

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

    PhoneLogMessage data, response status code and response headers



877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 877

def get_phone_log_by_id_with_http_info(phone_log_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_phone_log_by_id ...'
  end
  # verify the required parameter 'phone_log_id' is set
  if @api_client.config.client_side_validation && phone_log_id.nil?
    fail ArgumentError, "Missing the required parameter 'phone_log_id' when calling CommunicationsApi.get_phone_log_by_id"
  end
  # resource path
  local_var_path = '/v1/communications/phonelogs/{phoneLogId}'.sub('{' + 'phoneLogId' + '}', CGI.escape(phone_log_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] || 'PhoneLogMessage'

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

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

#get_phone_logs(opts = {}) ⇒ Array<PhoneLogMessage>

Retrieve all phone logs Retrieves all phone logs. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Communications &gt; Timelines (Phone Logs)</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fromdate (Date) —

    Filters results to any phone log whose call date is greater than or equal to the specified value.

  • :todate (Date) —

    Filters results to any phone log whose call date is less than or equal to the specified value.

  • :loggedbystaffuserids (Array<Integer>) —

    Filters results to any phone log that was logged by staff user(s).

  • :subject (String) —

    Filters results to any phone log whose subject contains the specified value.

  • :participantentityid (Integer) —

    Filters results to any phone logs that match the participant identifier. Note, if a value is provided in this field the &#x60;ParticipantEntityType&#x60; must also be provided.

  • :participantentitytype (String) —

    Filters results to any phone log with the specified participant type. This field is required if a value is provided for the &#x60;ParticipantEntityId&#x60; field.

  • :unitagreementid (Integer) —

    Filters results to any phone log with the specified unit agreement identifier. Note, if a value is provided in this field the &#x60;UnitAgreementType&#x60; must also be provided.

  • :unitagreementtype (String) —

    Filters results to any phone log with the specified unit agreement type. This field is required if a value is provided for the &#x60;UnitAgreementId&#x60; field.

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



940
941
942
943
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 940

def get_phone_logs(opts = {})
  data, _status_code, _headers = get_phone_logs_with_http_info(opts)
  data
end

#get_phone_logs_with_http_info(opts = {}) ⇒ Array<(Array<PhoneLogMessage>, Integer, Hash)>

Retrieve all phone logs Retrieves all phone logs. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Communications &amp;gt; Timelines (Phone Logs)&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fromdate (Date) —

    Filters results to any phone log whose call date is greater than or equal to the specified value.

  • :todate (Date) —

    Filters results to any phone log whose call date is less than or equal to the specified value.

  • :loggedbystaffuserids (Array<Integer>) —

    Filters results to any phone log that was logged by staff user(s).

  • :subject (String) —

    Filters results to any phone log whose subject contains the specified value.

  • :participantentityid (Integer) —

    Filters results to any phone logs that match the participant identifier. Note, if a value is provided in this field the &#x60;ParticipantEntityType&#x60; must also be provided.

  • :participantentitytype (String) —

    Filters results to any phone log with the specified participant type. This field is required if a value is provided for the &#x60;ParticipantEntityId&#x60; field.

  • :unitagreementid (Integer) —

    Filters results to any phone log with the specified unit agreement identifier. Note, if a value is provided in this field the &#x60;UnitAgreementType&#x60; must also be provided.

  • :unitagreementtype (String) —

    Filters results to any phone log with the specified unit agreement type. This field is required if a value is provided for the &#x60;UnitAgreementId&#x60; field.

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

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



960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 960

def get_phone_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.get_phone_logs ...'
  end
  allowable_values = ["Vendor", "RentalOwner", "RentalTenant", "AssociationOwner"]
  if @api_client.config.client_side_validation && opts[:'participantentitytype'] && !allowable_values.include?(opts[:'participantentitytype'])
    fail ArgumentError, "invalid value for \"participantentitytype\", must be one of #{allowable_values}"
  end
  allowable_values = ["Lease", "OwnershipAccount"]
  if @api_client.config.client_side_validation && opts[:'unitagreementtype'] && !allowable_values.include?(opts[:'unitagreementtype'])
    fail ArgumentError, "invalid value for \"unitagreementtype\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/communications/phonelogs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fromdate'] = opts[:'fromdate'] if !opts[:'fromdate'].nil?
  query_params[:'todate'] = opts[:'todate'] if !opts[:'todate'].nil?
  query_params[:'loggedbystaffuserids'] = @api_client.build_collection_param(opts[:'loggedbystaffuserids'], :multi) if !opts[:'loggedbystaffuserids'].nil?
  query_params[:'subject'] = opts[:'subject'] if !opts[:'subject'].nil?
  query_params[:'participantentityid'] = opts[:'participantentityid'] if !opts[:'participantentityid'].nil?
  query_params[:'participantentitytype'] = opts[:'participantentitytype'] if !opts[:'participantentitytype'].nil?
  query_params[:'unitagreementid'] = opts[:'unitagreementid'] if !opts[:'unitagreementid'].nil?
  query_params[:'unitagreementtype'] = opts[:'unitagreementtype'] if !opts[:'unitagreementtype'].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<PhoneLogMessage>'

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

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

#update_phone_log(phone_log_id, phone_log_put_message, opts = {}) ⇒ PhoneLogMessage

Update a phone log Update a phone log <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">Communications &gt; Timelines (Phone Logs)</span> - ‘View` `Edit`

Parameters:

  • phone_log_id (Integer) —

    The phone log identifier.

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

    the optional parameters

Returns:



1029
1030
1031
1032
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 1029

def update_phone_log(phone_log_id, phone_log_put_message, opts = {})
  data, _status_code, _headers = update_phone_log_with_http_info(phone_log_id, phone_log_put_message, opts)
  data
end

#update_phone_log_with_http_info(phone_log_id, phone_log_put_message, opts = {}) ⇒ Array<(PhoneLogMessage, Integer, Hash)>

Update a phone log Update a phone log &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;Communications &amp;gt; Timelines (Phone Logs)&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • phone_log_id (Integer) —

    The phone log identifier.

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

    the optional parameters

Returns:

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

    PhoneLogMessage data, response status code and response headers



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/buildium-ruby/api/communications_api.rb', line 1040

def update_phone_log_with_http_info(phone_log_id, phone_log_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationsApi.update_phone_log ...'
  end
  # verify the required parameter 'phone_log_id' is set
  if @api_client.config.client_side_validation && phone_log_id.nil?
    fail ArgumentError, "Missing the required parameter 'phone_log_id' when calling CommunicationsApi.update_phone_log"
  end
  # verify the required parameter 'phone_log_put_message' is set
  if @api_client.config.client_side_validation && phone_log_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'phone_log_put_message' when calling CommunicationsApi.update_phone_log"
  end
  # resource path
  local_var_path = '/v1/communications/phonelogs/{phoneLogId}'.sub('{' + 'phoneLogId' + '}', CGI.escape(phone_log_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(phone_log_put_message)

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

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

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