Class: Buildium::ResidentRequestsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResidentRequestsApi

Returns a new instance of ResidentRequestsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_resource(resident_request_task_post_message, opts = {}) ⇒ ResidentRequestTaskMessage

Create a resident request Creates a resident request. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View` `Edit`

Parameters:

Returns:



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

def create_resource(resident_request_task_post_message, opts = {})
  data, _status_code, _headers = create_resource_with_http_info(resident_request_task_post_message, opts)
  data
end

#create_resource_with_http_info(resident_request_task_post_message, opts = {}) ⇒ Array<(ResidentRequestTaskMessage, Integer, Hash)>

Create a resident request Creates a resident request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:

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

    ResidentRequestTaskMessage 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/resident_requests_api.rb', line 37

def create_resource_with_http_info(resident_request_task_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResidentRequestsApi.create_resource ...'
  end
  # verify the required parameter 'resident_request_task_post_message' is set
  if @api_client.config.client_side_validation && resident_request_task_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'resident_request_task_post_message' when calling ResidentRequestsApi.create_resource"
  end
  # resource path
  local_var_path = '/v1/tasks/residentrequests'

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

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

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

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

#get_resident_request_task(resident_request_task_id, opts = {}) ⇒ ResidentRequestTaskMessage

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

Parameters:

  • resident_request_task_id (Integer) —

    The resident request identifier.

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

    the optional parameters

Returns:



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

def get_resident_request_task(resident_request_task_id, opts = {})
  data, _status_code, _headers = get_resident_request_task_with_http_info(resident_request_task_id, opts)
  data
end

#get_resident_request_task_with_http_info(resident_request_task_id, opts = {}) ⇒ Array<(ResidentRequestTaskMessage, Integer, Hash)>

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

Parameters:

  • resident_request_task_id (Integer) —

    The resident request identifier.

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

    the optional parameters

Returns:

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

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

def get_resident_request_task_with_http_info(resident_request_task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResidentRequestsApi.get_resident_request_task ...'
  end
  # verify the required parameter 'resident_request_task_id' is set
  if @api_client.config.client_side_validation && resident_request_task_id.nil?
    fail ArgumentError, "Missing the required parameter 'resident_request_task_id' when calling ResidentRequestsApi.get_resident_request_task"
  end
  # resource path
  local_var_path = '/v1/tasks/residentrequests/{residentRequestTaskId}'.sub('{' + 'residentRequestTaskId' + '}', CGI.escape(resident_request_task_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] || 'ResidentRequestTaskMessage'

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

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

#get_resident_request_tasks(opts = {}) ⇒ Array<ResidentRequestTaskMessage>

Retrieve all resident requests Retrieves a list of resident requests. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Tasks &gt; Tasks</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :entityid (Integer) —

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

  • :statuses (Array<String>) —

    Filters results by the status of the task. If no status is specified, tasks with any status will be returned.

  • :unitid (Integer) —

    Filters results to any task associated with the unit identifier.

  • :unitagreementid (Integer) —

    Filters results to any task associated with the unit agreement identifier specified.

  • :lastupdatedfrom (Date) —

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

  • :lastupdatedto (Date) —

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

  • :duedatefrom (Date) —

    Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • :duedateto (Date) —

    Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • :taskcategoryid (Integer) —

    Filters results to any tasks with the specified category identifier.

  • :priorities (Array<String>) —

    Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.

  • :assignedtoid (Integer) —

    Filters results to any tasks that have been assigned to the specified staff user identifier.

  • :tasktitle (String) —

    Filters results to any task whose title contains the specified value.

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



173
174
175
176
 
# File 'lib/buildium-ruby/api/resident_requests_api.rb', line 173

def get_resident_request_tasks(opts = {})
  data, _status_code, _headers = get_resident_request_tasks_with_http_info(opts)
  data
end

#get_resident_request_tasks_with_http_info(opts = {}) ⇒ Array<(Array<ResidentRequestTaskMessage>, Integer, Hash)>

Retrieve all resident requests Retrieves a list of resident requests. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Tasks &amp;gt; Tasks&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 the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.

  • :entityid (Integer) —

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

  • :statuses (Array<String>) —

    Filters results by the status of the task. If no status is specified, tasks with any status will be returned.

  • :unitid (Integer) —

    Filters results to any task associated with the unit identifier.

  • :unitagreementid (Integer) —

    Filters results to any task associated with the unit agreement identifier specified.

  • :lastupdatedfrom (Date) —

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

  • :lastupdatedto (Date) —

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

  • :duedatefrom (Date) —

    Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • :duedateto (Date) —

    Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • :taskcategoryid (Integer) —

    Filters results to any tasks with the specified category identifier.

  • :priorities (Array<String>) —

    Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.

  • :assignedtoid (Integer) —

    Filters results to any tasks that have been assigned to the specified staff user identifier.

  • :tasktitle (String) —

    Filters results to any task whose title contains the specified value.

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

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



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/buildium-ruby/api/resident_requests_api.rb', line 198

def get_resident_request_tasks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResidentRequestsApi.get_resident_request_tasks ...'
  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
  allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
  if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
  end
  allowable_values = ["Low", "Normal", "High"]
  if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/tasks/residentrequests'

  # 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[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
  query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
  query_params[:'unitagreementid'] = opts[:'unitagreementid'] if !opts[:'unitagreementid'].nil?
  query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
  query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
  query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
  query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
  query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
  query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
  query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
  query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].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<ResidentRequestTaskMessage>'

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

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

#update_resource(resident_request_task_id, resident_request_task_put_message, opts = {}) ⇒ ResidentRequestTaskMessage

Update a resident request Update a resident request. <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">Tasks &gt; Tasks</span> - ‘View` `Edit`

Parameters:

  • resident_request_task_id (Integer) —

    The resident request identifier.

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

    the optional parameters

Returns:



276
277
278
279
 
# File 'lib/buildium-ruby/api/resident_requests_api.rb', line 276

def update_resource(resident_request_task_id, resident_request_task_put_message, opts = {})
  data, _status_code, _headers = update_resource_with_http_info(resident_request_task_id, resident_request_task_put_message, opts)
  data
end

#update_resource_with_http_info(resident_request_task_id, resident_request_task_put_message, opts = {}) ⇒ Array<(ResidentRequestTaskMessage, Integer, Hash)>

Update a resident request Update a resident request. &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;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • resident_request_task_id (Integer) —

    The resident request identifier.

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

    the optional parameters

Returns:

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

    ResidentRequestTaskMessage data, response status code and response headers



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

def update_resource_with_http_info(resident_request_task_id, resident_request_task_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResidentRequestsApi.update_resource ...'
  end
  # verify the required parameter 'resident_request_task_id' is set
  if @api_client.config.client_side_validation && resident_request_task_id.nil?
    fail ArgumentError, "Missing the required parameter 'resident_request_task_id' when calling ResidentRequestsApi.update_resource"
  end
  # verify the required parameter 'resident_request_task_put_message' is set
  if @api_client.config.client_side_validation && resident_request_task_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'resident_request_task_put_message' when calling ResidentRequestsApi.update_resource"
  end
  # resource path
  local_var_path = '/v1/tasks/residentrequests/{residentRequestTaskId}'.sub('{' + 'residentRequestTaskId' + '}', CGI.escape(resident_request_task_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(resident_request_task_put_message)

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

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

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