class Beanie::JournalApi
Attributes
Public Class Methods
# File lib/beanie/api/journal_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Creates a new journal in the system @param journals Journal
to add to the system @param [Hash] opts the optional parameters @return [Journal]
# File lib/beanie/api/journal_api.rb, line 26 def add_journal(journals, opts = {}) data, _status_code, _headers = add_journal_with_http_info(journals, opts) data end
Creates a new journal in the system @param journals Journal
to add to the system @param [Hash] opts the optional parameters @return [Array<(Journal
, Fixnum, Hash)>] Journal
data, response status code and response headers
# File lib/beanie/api/journal_api.rb, line 35 def add_journal_with_http_info(journals, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: JournalApi.add_journal ...' end # verify the required parameter 'journals' is set if @api_client.config.client_side_validation && journals.nil? fail ArgumentError, "Missing the required parameter 'journals' when calling JournalApi.add_journal" end # resource path local_var_path = '/journals' # 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(journals) 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 => 'Journal') if @api_client.config.debugging @api_client.config.logger.debug "API called: JournalApi#add_journal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Find Journal
by ID Returns a single journal if the user has access @param id ID of journal to fetch @param [Hash] opts the optional parameters @return [Journal]
# File lib/beanie/api/journal_api.rb, line 79 def find_journal_by_id(id, opts = {}) data, _status_code, _headers = find_journal_by_id_with_http_info(id, opts) data end
Find Journal
by ID Returns a single journal if the user has access @param id ID of journal to fetch @param [Hash] opts the optional parameters @return [Array<(Journal
, Fixnum, Hash)>] Journal
data, response status code and response headers
# File lib/beanie/api/journal_api.rb, line 89 def find_journal_by_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: JournalApi.find_journal_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 JournalApi.find_journal_by_id" end # resource path local_var_path = '/journals/{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 => 'Journal') if @api_client.config.debugging @api_client.config.logger.debug "API called: JournalApi#find_journal_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
All journal Returns all journal 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<Journal>]
# File lib/beanie/api/journal_api.rb, line 134 def find_journals(opts = {}) data, _status_code, _headers = find_journals_with_http_info(opts) data end
All journal Returns all journal 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<Journal>, Fixnum, Hash)>] Array<Journal> data, response status code and response headers
# File lib/beanie/api/journal_api.rb, line 145 def find_journals_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: JournalApi.find_journals ...' end # resource path local_var_path = '/journals' # 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<Journal>') if @api_client.config.debugging @api_client.config.logger.debug "API called: JournalApi#find_journals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end