Method: Propertyware::DocumentsApi#retrieve_all_documents_with_http_info

Defined in:
lib/propertyware/api/documents_api.rb

#retrieve_all_documents_with_http_info(entity_type, opts = {}) ⇒ Array<(Array<Document>, Integer, Hash)>

Retrieve all documents Retrieves a list of documents associated with a specific entity.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;DOCUMENTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

  • entity_type (String) —

    Filters results to documents associated with a specific entity type.

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :entity_id (Integer) —

    Filters results to documents associated with a specific entity id. entity ID is not required for DESKTOP and OTHER. Remaining entities need entity ID.

Returns:

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

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



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
225
226
227
228
229
230
231
232
233
 
# File 'lib/propertyware/api/documents_api.rb', line 175

def retrieve_all_documents_with_http_info(entity_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.retrieve_all_documents ...'
  end
  # verify the required parameter 'entity_type' is set
  if @api_client.config.client_side_validation && entity_type.nil?
    fail ArgumentError, "Missing the required parameter 'entity_type' when calling DocumentsApi.retrieve_all_documents"
  end
  # verify enum value
  allowable_values = ["APPOINTMENT", "ASSET", "BILL", "BANK_DEPOSIT", "BILL_PAYMENT", "BUILDING", "CONTACT", "FLOOR_PLAN", "DESKTOP", "EMAIL_TEMPLATE", "INSPECTION", "LEASE", "OTHER", "PORTFOLIO", "PROSPECT", "RECONCILIATION", "TASK", "TRANSACTION", "UNIT", "VENDOR", "WORK_ORDER"]
  if @api_client.config.client_side_validation && !allowable_values.include?(entity_type)
    fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/docs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'entityType'] = entity_type
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].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<Document>'

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

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