class KoronaCloudClient::AdditionalReceiptInfoTypesApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/korona-cloud-client/api/additional_receipt_info_types_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_additional_receipt_info_type(korona_account_id, additional_receipt_info_type_id, opts = {}) click to toggle source

returns the single additional receipt info type @param korona_account_id [String] account id of the KORONA.cloud account @param additional_receipt_info_type_id [String] id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [AdditionalReceiptInfoType]

# File lib/korona-cloud-client/api/additional_receipt_info_types_api.rb, line 27
def get_additional_receipt_info_type(korona_account_id, additional_receipt_info_type_id, opts = {})
  data, _status_code, _headers = get_additional_receipt_info_type_with_http_info(korona_account_id, additional_receipt_info_type_id, opts)
  data
end
get_additional_receipt_info_type_with_http_info(korona_account_id, additional_receipt_info_type_id, opts = {}) click to toggle source

returns the single additional receipt info type @param korona_account_id [String] account id of the KORONA.cloud account @param additional_receipt_info_type_id [String] id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Array<(AdditionalReceiptInfoType, Integer, Hash)>] AdditionalReceiptInfoType data, response status code and response headers

# File lib/korona-cloud-client/api/additional_receipt_info_types_api.rb, line 37
def get_additional_receipt_info_type_with_http_info(korona_account_id, additional_receipt_info_type_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdditionalReceiptInfoTypesApi.get_additional_receipt_info_type ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && korona_account_id.nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling AdditionalReceiptInfoTypesApi.get_additional_receipt_info_type"
  end
  # verify the required parameter 'additional_receipt_info_type_id' is set
  if @api_client.config.client_side_validation && additional_receipt_info_type_id.nil?
    fail ArgumentError, "Missing the required parameter 'additional_receipt_info_type_id' when calling AdditionalReceiptInfoTypesApi.get_additional_receipt_info_type"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/additionalReceiptInfoTypes/{additionalReceiptInfoTypeId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'additionalReceiptInfoTypeId' + '}', CGI.escape(additional_receipt_info_type_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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[:body] 

  # return_type
  return_type = opts[:return_type] || 'AdditionalReceiptInfoType' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  new_options = opts.merge(
    :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: AdditionalReceiptInfoTypesApi#get_additional_receipt_info_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_additional_receipt_info_types(korona_account_id, opts = {}) click to toggle source

lists all additional receipt info types @param korona_account_id [String] account id of the KORONA.cloud account @param [Hash] opts the optional parameters @option opts [Integer] :page number of the page to fetch @option opts [Integer] :size amount of objects to return per page @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5) @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned @option opts [Boolean] :include_deleted indicates deleted objects should be loaded or not (default: false) @option opts [String] :number number of the related object @return [ResultListAdditionalReceiptInfoType]

# File lib/korona-cloud-client/api/additional_receipt_info_types_api.rb, line 98
def get_additional_receipt_info_types(korona_account_id, opts = {})
  data, _status_code, _headers = get_additional_receipt_info_types_with_http_info(korona_account_id, opts)
  data
end
get_additional_receipt_info_types_with_http_info(korona_account_id, opts = {}) click to toggle source

lists all additional receipt info types @param korona_account_id [String] account id of the KORONA.cloud account @param [Hash] opts the optional parameters @option opts [Integer] :page number of the page to fetch @option opts [Integer] :size amount of objects to return per page @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5) @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned @option opts [Boolean] :include_deleted indicates deleted objects should be loaded or not (default: false) @option opts [String] :number number of the related object @return [Array<(ResultListAdditionalReceiptInfoType, Integer, Hash)>] ResultListAdditionalReceiptInfoType data, response status code and response headers

# File lib/korona-cloud-client/api/additional_receipt_info_types_api.rb, line 113
def get_additional_receipt_info_types_with_http_info(korona_account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdditionalReceiptInfoTypesApi.get_additional_receipt_info_types ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && korona_account_id.nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling AdditionalReceiptInfoTypesApi.get_additional_receipt_info_types"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/additionalReceiptInfoTypes'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ResultListAdditionalReceiptInfoType' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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