class Beanie::DocumentApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/beanie/api/document_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

add_document(documents, opts = {}) click to toggle source

Creates a new document in the system @param documents Document to add to the system @param [Hash] opts the optional parameters @return [Document]

# File lib/beanie/api/document_api.rb, line 26
def add_document(documents, opts = {})
  data, _status_code, _headers = add_document_with_http_info(documents, opts)
  data
end
add_document_with_http_info(documents, opts = {}) click to toggle source

Creates a new document in the system @param documents Document to add to the system @param [Hash] opts the optional parameters @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers

# File lib/beanie/api/document_api.rb, line 35
def add_document_with_http_info(documents, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentApi.add_document ...'
  end
  # verify the required parameter 'documents' is set
  if @api_client.config.client_side_validation && documents.nil?
    fail ArgumentError, "Missing the required parameter 'documents' when calling DocumentApi.add_document"
  end
  # resource path
  local_var_path = '/documents'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(documents)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentApi#add_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
find_document_by_id(id, opts = {}) click to toggle source

Find Document by ID Returns a single document if the user has access @param id ID of document to fetch @param [Hash] opts the optional parameters @return [Document]

# File lib/beanie/api/document_api.rb, line 79
def find_document_by_id(id, opts = {})
  data, _status_code, _headers = find_document_by_id_with_http_info(id, opts)
  data
end
find_document_by_id_with_http_info(id, opts = {}) click to toggle source

Find Document by ID Returns a single document if the user has access @param id ID of document to fetch @param [Hash] opts the optional parameters @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers

# File lib/beanie/api/document_api.rb, line 89
def find_document_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentApi.find_document_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentApi.find_document_by_id"
  end
  # resource path
  local_var_path = '/documents/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentApi#find_document_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
find_documents(opts = {}) click to toggle source

All document Returns all document from the system that the user has access to @param [Hash] opts the optional parameters @option opts [Array<String>] :tags tags to filter by @option opts [Integer] :limit Maximum number of results to return @return [Array<Document>]

# File lib/beanie/api/document_api.rb, line 134
def find_documents(opts = {})
  data, _status_code, _headers = find_documents_with_http_info(opts)
  data
end
find_documents_with_http_info(opts = {}) click to toggle source

All document Returns all document from the system that the user has access to @param [Hash] opts the optional parameters @option opts [Array<String>] :tags tags to filter by @option opts [Integer] :limit Maximum number of results to return @return [Array<(Array<Document>, Fixnum, Hash)>] Array<Document> data, response status code and response headers

# File lib/beanie/api/document_api.rb, line 145
def find_documents_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentApi.find_documents ...'
  end
  # resource path
  local_var_path = '/documents'

  # query parameters
  query_params = {}
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'Array<Document>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentApi#find_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end