Method: DocuSign_eSign::FoldersApi#list_items_with_http_info

Defined in:

lib/docusign_esign/api/folders_api.rb

#list_items_with_http_info(account_id, folder_id, options = DocuSign_eSign::ListItemsOptions.default) ⇒ Array<(FolderItemsResponse, Fixnum, Hash)>

Gets a list of the envelopes in the specified folder. Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

Parameters:

• account_id —

  The external account number (int) or account ID Guid.

• folder_id —

  The ID of the folder being accessed.

• DocuSign_eSign::ListItemsOptions —

  Options for modifying the behavior of the function.

Returns:

• (Array<(FolderItemsResponse, Fixnum, Hash)>) —

  FolderItemsResponse data, response status code and response headers

# File 'lib/docusign_esign/api/folders_api.rb', line 178

def list_items_with_http_info(account_id, folder_id, options = DocuSign_eSign::ListItemsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FoldersApi.list_items ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FoldersApi.list_items" if account_id.nil?
  # verify the required parameter 'folder_id' is set
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling FoldersApi.list_items" if folder_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'include_items'] = options.include_items if !options.include_items.nil?
  query_params[:'owner_email'] = options.owner_email if !options.owner_email.nil?
  query_params[:'owner_name'] = options.owner_name if !options.owner_name.nil?
  query_params[:'search_text'] = options.search_text if !options.search_text.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FolderItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FoldersApi#list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end