class KoronaClient::PriceGroupsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_price_group(korona_account_id, price_group_id, opts = {}) click to toggle source

returns the single price group

@param korona_account_id account id of the KORONA.cloud account @param price_group_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [PriceGroup]

# File lib/korona_client/api/price_groups_api.rb, line 28
def get_price_group(korona_account_id, price_group_id, opts = {})
  data, _status_code, _headers = get_price_group_with_http_info(korona_account_id, price_group_id, opts)
  data
end
get_price_group_with_http_info(korona_account_id, price_group_id, opts = {}) click to toggle source

returns the single price group

@param korona_account_id account id of the KORONA.cloud account @param price_group_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Array<(PriceGroup, Fixnum, Hash)>] PriceGroup data, response status code and response headers

# File lib/korona_client/api/price_groups_api.rb, line 39
def get_price_group_with_http_info(korona_account_id, price_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PriceGroupsApi.get_price_group ...'
  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 PriceGroupsApi.get_price_group"
  end
  # verify the required parameter 'price_group_id' is set
  if @api_client.config.client_side_validation && price_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'price_group_id' when calling PriceGroupsApi.get_price_group"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/priceGroups/{priceGroupId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'priceGroupId' + '}', price_group_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 = ['basicAuth']
  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 => 'PriceGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PriceGroupsApi#get_price_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_price_groups(korona_account_id, opts = {}) click to toggle source

lists all price groups

@param korona_account_id 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 [ResultListPriceGroup]

# File lib/korona_client/api/price_groups_api.rb, line 93
def get_price_groups(korona_account_id, opts = {})
  data, _status_code, _headers = get_price_groups_with_http_info(korona_account_id, opts)
  data
end
get_price_groups_with_http_info(korona_account_id, opts = {}) click to toggle source

lists all price groups

@param korona_account_id 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<(ResultListPriceGroup, Fixnum, Hash)>] ResultListPriceGroup data, response status code and response headers

# File lib/korona_client/api/price_groups_api.rb, line 109
def get_price_groups_with_http_info(korona_account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PriceGroupsApi.get_price_groups ...'
  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 PriceGroupsApi.get_price_groups"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/priceGroups'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s)

  # query parameters
  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 = {}
  # 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 = ['basicAuth']
  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 => 'ResultListPriceGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PriceGroupsApi#get_price_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end