Class: Buildium::ArchitecturalRequestsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ArchitecturalRequestsApi

Returns a new instance of ArchitecturalRequestsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_architectural_request_async(create_architectural_request_async_request, opts = {}) ⇒ AssociationArchitecturalRequestMessage

Create an architectural request Creates an architectural request <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - ‘View` `Edit` <br /><span class="permissionBlock">Associations > Ownership accounts</span> - `View` `Edit` <br /><span class="permissionBlock">Associations > Architectural requests</span> - `View` `Edit` <br /><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit` <br />

Parameters:

Returns:



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

def create_architectural_request_async(create_architectural_request_async_request, opts = {})
  data, _status_code, _headers = create_architectural_request_async_with_http_info(create_architectural_request_async_request, opts)
  data
end

#create_architectural_request_async_with_http_info(create_architectural_request_async_request, opts = {}) ⇒ Array<(AssociationArchitecturalRequestMessage, Integer, Hash)>

Create an architectural request Creates an architectural request &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Associations and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Architectural requests&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;

Parameters:

Returns:



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

def create_architectural_request_async_with_http_info(create_architectural_request_async_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchitecturalRequestsApi.create_architectural_request_async ...'
  end
  # verify the required parameter 'create_architectural_request_async_request' is set
  if @api_client.config.client_side_validation && create_architectural_request_async_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_architectural_request_async_request' when calling ArchitecturalRequestsApi.create_architectural_request_async"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/architecturalrequests'

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

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

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

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

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

#create_upload_file_request(architectural_request_id, create_upload_file_request_request, opts = {}) ⇒ FileUploadTicketMessage

Upload an architectural request file Uploads a file and associates it to the specified architectural request record. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> The first step in the file upload process is to submit the file metadata to ‘/v1/associations/ownershipaccounts/architecturalrequests/architecturalRequestId:int/files/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. <br /><br /><strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you’re using Postman: <img src="file-upload-example.png" /><br /><br /> 5. Send the POST request! A successful request will return with a ‘204 - NO CONTENT` HTTP response code. For any failure responses, please refer to <a target="_blank" href="docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses">AWS documentation</a> on REST error responses. <br /><br /><strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit` <br /><span class="permissionBlock">Associations > Ownership accounts</span> - `View` `Edit` <br /><span class="permissionBlock">Associations > Architectural requests</span> - `View` `Edit` <br /><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Parameters:

  • architectural_request_id (Integer)
  • create_upload_file_request_request (CreateUploadFileRequestRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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

def create_upload_file_request(architectural_request_id, create_upload_file_request_request, opts = {})
  data, _status_code, _headers = create_upload_file_request_with_http_info(architectural_request_id, create_upload_file_request_request, opts)
  data
end

#create_upload_file_request_with_http_info(architectural_request_id, create_upload_file_request_request, opts = {}) ⇒ Array<(FileUploadTicketMessage, Integer, Hash)>

Upload an architectural request file Uploads a file and associates it to the specified architectural request record. &lt;br /&gt;&lt;br /&gt;Uploading a file requires making two API requests. Each step is outlined below. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 1 - Save file metadata&lt;/strong&gt;&lt;br /&gt; The first step in the file upload process is to submit the file metadata to &#x60;/v1/associations/ownershipaccounts/architecturalrequests/architecturalRequestId:int/files/uploadrequests&#x60;. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 2 - Upload the file binary&lt;/strong&gt;&lt;br /&gt; Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: &lt;br /&gt; 1. Form a POST request using the value of the &#x60;BucketUrl&#x60; property as the URL. &lt;br /&gt;&lt;br /&gt; 2. Set the &#x60;Content-Type&#x60; header to &#x60;multipart/form-data&#x60;. &lt;br /&gt;&lt;br /&gt; 3. Copy the fields from the &#x60;FormData&#x60; property to this request as form-data key/value pairs. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; These values must added to the request form-data in the order they were received in the response. &lt;br /&gt;&lt;br /&gt; 4. Lastly create a form-data key named &#x60;file&#x60; and set the value to the file binary. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; This must be the last field in the form-data list. &lt;br /&gt;&lt;br /&gt;This image shows what the POST request should look like if you&#39;re using Postman: &lt;img src&#x3D;&quot;file-upload-example.png&quot; /&gt;&lt;br /&gt;&lt;br /&gt; 5. Send the POST request! A successful request will return with a &#x60;204 - NO CONTENT&#x60; HTTP response code. For any failure responses, please refer to &lt;a target&#x3D;&quot;_blank&quot; href&#x3D;&quot;docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses&quot;&gt;AWS documentation&lt;/a&gt; on REST error responses. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; The file identifier is not generated in this response. To retrieve the file identifier, call &#x60;/v1/files&#x60; and pass the &#x60;PhysicalFileName&#x60; value received from the response of this endpoint into the &#x60;physicalfilenames&#x60; query parameter. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Associations and units&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Architectural requests&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • architectural_request_id (Integer)
  • create_upload_file_request_request (CreateUploadFileRequestRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    FileUploadTicketMessage data, response status code and response headers



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
157
158
159
160
161
162
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 107

def create_upload_file_request_with_http_info(architectural_request_id, create_upload_file_request_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchitecturalRequestsApi.create_upload_file_request ...'
  end
  # verify the required parameter 'architectural_request_id' is set
  if @api_client.config.client_side_validation && architectural_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'architectural_request_id' when calling ArchitecturalRequestsApi.create_upload_file_request"
  end
  # verify the required parameter 'create_upload_file_request_request' is set
  if @api_client.config.client_side_validation && create_upload_file_request_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_upload_file_request_request' when calling ArchitecturalRequestsApi.create_upload_file_request"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/architecturalrequests/{architecturalRequestId}/files/uploadrequests'.sub('{' + 'architecturalRequestId' + '}', CGI.escape(architectural_request_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(create_upload_file_request_request)

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

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

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

#download_architectural_request_file_async(architectural_request_id, file_id, opts = {}) ⇒ FileDownloadMessage

Download an architectural request file Downloads a specific file associated to the architectural request. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - ‘View` <br /><span class="permissionBlock">Associations > Ownership accounts</span> - `View` <br /><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <br /><span class="permissionBlock">Associations > Architectural requests</span> - `View`

Parameters:

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

    the optional parameters

Returns:



170
171
172
173
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 170

def download_architectural_request_file_async(architectural_request_id, file_id, opts = {})
  data, _status_code, _headers = download_architectural_request_file_async_with_http_info(architectural_request_id, file_id, opts)
  data
end

#download_architectural_request_file_async_with_http_info(architectural_request_id, file_id, opts = {}) ⇒ Array<(FileDownloadMessage, Integer, Hash)>

Download an architectural request file Downloads a specific file associated to the architectural request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Associations and units&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Architectural requests&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    FileDownloadMessage data, response status code and response headers



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
225
226
227
228
229
230
231
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 181

def download_architectural_request_file_async_with_http_info(architectural_request_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchitecturalRequestsApi.download_architectural_request_file_async ...'
  end
  # verify the required parameter 'architectural_request_id' is set
  if @api_client.config.client_side_validation && architectural_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'architectural_request_id' when calling ArchitecturalRequestsApi.download_architectural_request_file_async"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling ArchitecturalRequestsApi.download_architectural_request_file_async"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/architecturalrequests/{architecturalRequestId}/files/{fileId}/downloadrequests'.sub('{' + 'architecturalRequestId' + '}', CGI.escape(architectural_request_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_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] || 'FileDownloadMessage'

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

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

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

#get_architectural_request_by_id(architectural_request_id, opts = {}) ⇒ AssociationArchitecturalRequestMessage

Retrieve an architectural request Retrieves a specific architectural request. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - ‘View` <br /><span class="permissionBlock">Associations > Ownership accounts</span> - `View` <br /><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <br /><span class="permissionBlock">Associations > Architectural requests</span> - `View`

Parameters:

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 238

def get_architectural_request_by_id(architectural_request_id, opts = {})
  data, _status_code, _headers = get_architectural_request_by_id_with_http_info(architectural_request_id, opts)
  data
end

#get_architectural_request_by_id_with_http_info(architectural_request_id, opts = {}) ⇒ Array<(AssociationArchitecturalRequestMessage, Integer, Hash)>

Retrieve an architectural request Retrieves a specific architectural request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Associations and units&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Architectural requests&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 248

def get_architectural_request_by_id_with_http_info(architectural_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchitecturalRequestsApi.get_architectural_request_by_id ...'
  end
  # verify the required parameter 'architectural_request_id' is set
  if @api_client.config.client_side_validation && architectural_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'architectural_request_id' when calling ArchitecturalRequestsApi.get_architectural_request_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/architecturalrequests/{architecturalRequestId}'.sub('{' + 'architecturalRequestId' + '}', CGI.escape(architectural_request_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] || 'AssociationArchitecturalRequestMessage'

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

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

#get_architectural_request_file_async(architectural_request_id, file_id, opts = {}) ⇒ AssociationArchitecturalRequestFileMessage

Retrieve an architectural request file Retrieves an architectural request file. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - ‘View` <br /><span class="permissionBlock">Associations > Ownership accounts</span> - `View` <br /><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <br /><span class="permissionBlock">Associations > Architectural requests</span> - `View`

Parameters:

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

    the optional parameters

Returns:



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

def get_architectural_request_file_async(architectural_request_id, file_id, opts = {})
  data, _status_code, _headers = get_architectural_request_file_async_with_http_info(architectural_request_id, file_id, opts)
  data
end

#get_architectural_request_file_async_with_http_info(architectural_request_id, file_id, opts = {}) ⇒ Array<(AssociationArchitecturalRequestFileMessage, Integer, Hash)>

Retrieve an architectural request file Retrieves an architectural request file. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Associations and units&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Architectural requests&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 313

def get_architectural_request_file_async_with_http_info(architectural_request_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchitecturalRequestsApi.get_architectural_request_file_async ...'
  end
  # verify the required parameter 'architectural_request_id' is set
  if @api_client.config.client_side_validation && architectural_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'architectural_request_id' when calling ArchitecturalRequestsApi.get_architectural_request_file_async"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling ArchitecturalRequestsApi.get_architectural_request_file_async"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/architecturalrequests/{architecturalRequestId}/files/{fileId}'.sub('{' + 'architecturalRequestId' + '}', CGI.escape(architectural_request_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_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] || 'AssociationArchitecturalRequestFileMessage'

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

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

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

#get_architectural_request_files_history_paged_async(architectural_request_id, opts = {}) ⇒ AssociationArchitecturalRequestFileMessage

Retrieve all files for an architectural request Retrieves all files for an architectural request. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - ‘View` <br /><span class="permissionBlock">Associations > Ownership accounts</span> - `View` <br /><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <br /><span class="permissionBlock">Associations > Architectural requests</span> - `View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<Integer>) —

    The IDs of the architectural request files to filter by.

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



374
375
376
377
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 374

def get_architectural_request_files_history_paged_async(architectural_request_id, opts = {})
  data, _status_code, _headers = get_architectural_request_files_history_paged_async_with_http_info(architectural_request_id, opts)
  data
end

#get_architectural_request_files_history_paged_async_with_http_info(architectural_request_id, opts = {}) ⇒ Array<(AssociationArchitecturalRequestFileMessage, Integer, Hash)>

Retrieve all files for an architectural request Retrieves all files for an architectural request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Associations and units&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Architectural requests&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<Integer>) —

    The IDs of the architectural request files to filter by.

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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 388

def get_architectural_request_files_history_paged_async_with_http_info(architectural_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchitecturalRequestsApi.get_architectural_request_files_history_paged_async ...'
  end
  # verify the required parameter 'architectural_request_id' is set
  if @api_client.config.client_side_validation && architectural_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'architectural_request_id' when calling ArchitecturalRequestsApi.get_architectural_request_files_history_paged_async"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/architecturalrequests/{architecturalRequestId}/files'.sub('{' + 'architecturalRequestId' + '}', CGI.escape(architectural_request_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].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] || 'AssociationArchitecturalRequestFileMessage'

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

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

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

#get_architectural_requests(opts = {}) ⇒ Array<AssociationArchitecturalRequestMessage>

Retrieve all architectural requests Retrieves all architectural requests. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - ‘View` <br /><span class="permissionBlock">Associations > Ownership accounts</span> - `View` <br /><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <br /><span class="permissionBlock">Associations > Architectural requests</span> - `View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :associationids (Array<Integer>) —

    Filters results to only records that belong to the specified set of association identifiers.

  • :ownershipaccountids (Array<Integer>) —

    Filters results to only records that belong to the specified set of ownership account identifiers.

  • :ids (Array<Integer>) —

    Filters results to only records that belong to the specified set of architectural request identifiers.

  • :statuses (Array<String>) —

    Filters results to only records whose status is equal to the specified value.

  • :decisions (Array<String>) —

    Filters results to only records whose decision is equal to the specified value.

  • :createddatetimefrom (Time) —

    Filters results to only records that were created after this date. Must be formatted as &#x60;YYYY-MM-DDTHH:MM:SSZ&#x60;.

  • :createddatetimeto (Time) —

    Filters results to only records that were created before this date. Must be formatted as &#x60;YYYY-MM-DDTHH:MM:SSZ&#x60;.

  • :lastupdatedfrom (Time) —

    Filters results to only records that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :lastupdatedto (Time) —

    Filters results to only records that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :submitteddatetimefrom (Time) —

    Filters results to only records that were submitted on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :submitteddatetimeto (Time) —

    Filters results to only records that were submitted on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

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



458
459
460
461
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 458

def get_architectural_requests(opts = {})
  data, _status_code, _headers = get_architectural_requests_with_http_info(opts)
  data
end

#get_architectural_requests_with_http_info(opts = {}) ⇒ Array<(Array<AssociationArchitecturalRequestMessage>, Integer, Hash)>

Retrieve all architectural requests Retrieves all architectural requests. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Associations and units&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Ownership accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Association owners and tenants&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &gt; Architectural requests&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :associationids (Array<Integer>) —

    Filters results to only records that belong to the specified set of association identifiers.

  • :ownershipaccountids (Array<Integer>) —

    Filters results to only records that belong to the specified set of ownership account identifiers.

  • :ids (Array<Integer>) —

    Filters results to only records that belong to the specified set of architectural request identifiers.

  • :statuses (Array<String>) —

    Filters results to only records whose status is equal to the specified value.

  • :decisions (Array<String>) —

    Filters results to only records whose decision is equal to the specified value.

  • :createddatetimefrom (Time) —

    Filters results to only records that were created after this date. Must be formatted as &#x60;YYYY-MM-DDTHH:MM:SSZ&#x60;.

  • :createddatetimeto (Time) —

    Filters results to only records that were created before this date. Must be formatted as &#x60;YYYY-MM-DDTHH:MM:SSZ&#x60;.

  • :lastupdatedfrom (Time) —

    Filters results to only records that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :lastupdatedto (Time) —

    Filters results to only records that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :submitteddatetimefrom (Time) —

    Filters results to only records that were submitted on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

  • :submitteddatetimeto (Time) —

    Filters results to only records that were submitted on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.

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



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/buildium-ruby/api/architectural_requests_api.rb', line 481

def get_architectural_requests_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchitecturalRequestsApi.get_architectural_requests ...'
  end
  allowable_values = ["New", "InProgress", "Completed"]
  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 = ["Pending", "Approved", "Denied"]
  if @api_client.config.client_side_validation && opts[:'decisions'] && !opts[:'decisions'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"decisions\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/architecturalrequests'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'associationids'] = @api_client.build_collection_param(opts[:'associationids'], :multi) if !opts[:'associationids'].nil?
  query_params[:'ownershipaccountids'] = @api_client.build_collection_param(opts[:'ownershipaccountids'], :multi) if !opts[:'ownershipaccountids'].nil?
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].nil?
  query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
  query_params[:'decisions'] = @api_client.build_collection_param(opts[:'decisions'], :multi) if !opts[:'decisions'].nil?
  query_params[:'createddatetimefrom'] = opts[:'createddatetimefrom'] if !opts[:'createddatetimefrom'].nil?
  query_params[:'createddatetimeto'] = opts[:'createddatetimeto'] if !opts[:'createddatetimeto'].nil?
  query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
  query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
  query_params[:'submitteddatetimefrom'] = opts[:'submitteddatetimefrom'] if !opts[:'submitteddatetimefrom'].nil?
  query_params[:'submitteddatetimeto'] = opts[:'submitteddatetimeto'] if !opts[:'submitteddatetimeto'].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<AssociationArchitecturalRequestMessage>'

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

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