class Beanie::NominalAccountCategoryApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

add_nominal_account_category(nominal_account_categories, opts = {}) click to toggle source

Creates a new nominal account category in the system @param nominal_account_categories Nominal account category to add to the system @param [Hash] opts the optional parameters @return [NominalAccountCategory]

# File lib/beanie/api/nominal_account_category_api.rb, line 26
def add_nominal_account_category(nominal_account_categories, opts = {})
  data, _status_code, _headers = add_nominal_account_category_with_http_info(nominal_account_categories, opts)
  data
end
add_nominal_account_category_with_http_info(nominal_account_categories, opts = {}) click to toggle source

Creates a new nominal account category in the system @param nominal_account_categories Nominal account category to add to the system @param [Hash] opts the optional parameters @return [Array<(NominalAccountCategory, Fixnum, Hash)>] NominalAccountCategory data, response status code and response headers

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

  # 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(nominal_account_categories)
  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 => 'NominalAccountCategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NominalAccountCategoryApi#add_nominal_account_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
find_nominal_account_categories(opts = {}) click to toggle source

All nominal account category Returns all nominal account category 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<NominalAccountCategory>]

# File lib/beanie/api/nominal_account_category_api.rb, line 80
def find_nominal_account_categories(opts = {})
  data, _status_code, _headers = find_nominal_account_categories_with_http_info(opts)
  data
end
find_nominal_account_categories_with_http_info(opts = {}) click to toggle source

All nominal account category Returns all nominal account category 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<NominalAccountCategory>, Fixnum, Hash)>] Array<NominalAccountCategory> data, response status code and response headers

# File lib/beanie/api/nominal_account_category_api.rb, line 91
def find_nominal_account_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NominalAccountCategoryApi.find_nominal_account_categories ...'
  end
  # resource path
  local_var_path = '/nominal_account_categories'

  # 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<NominalAccountCategory>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NominalAccountCategoryApi#find_nominal_account_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
find_nominal_account_category_by_id(id, opts = {}) click to toggle source

Find Nominal account category by ID Returns a single nominal account category if the user has access @param id ID of nominal account category to fetch @param [Hash] opts the optional parameters @return [NominalAccountCategory]

# File lib/beanie/api/nominal_account_category_api.rb, line 133
def find_nominal_account_category_by_id(id, opts = {})
  data, _status_code, _headers = find_nominal_account_category_by_id_with_http_info(id, opts)
  data
end
find_nominal_account_category_by_id_with_http_info(id, opts = {}) click to toggle source

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

# File lib/beanie/api/nominal_account_category_api.rb, line 143
def find_nominal_account_category_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NominalAccountCategoryApi.find_nominal_account_category_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 NominalAccountCategoryApi.find_nominal_account_category_by_id"
  end
  # resource path
  local_var_path = '/nominal_account_categories/{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 => 'NominalAccountCategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NominalAccountCategoryApi#find_nominal_account_category_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end