class KoronaCloudClient::SectorsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

add_sectors(korona_account_id, body, opts = {}) click to toggle source

adds a batch of new sectors @param korona_account_id [String] account id of the KORONA.cloud account @param body [Array<Sector>] array of new sectors @param [Hash] opts the optional parameters @option opts [Boolean] :upsert when set to true, updates the object instead of generating a already-exists-error @return [Array<AddOrUpdateResult>]

# File lib/korona-cloud-client/api/sectors_api.rb, line 28
def add_sectors(korona_account_id, body, opts = {})
  data, _status_code, _headers = add_sectors_with_http_info(korona_account_id, body, opts)
  data
end
add_sectors_with_http_info(korona_account_id, body, opts = {}) click to toggle source

adds a batch of new sectors @param korona_account_id [String] account id of the KORONA.cloud account @param body [Array<Sector>] array of new sectors @param [Hash] opts the optional parameters @option opts [Boolean] :upsert when set to true, updates the object instead of generating a already-exists-error @return [Array<(Array<AddOrUpdateResult>, Integer, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers

# File lib/korona-cloud-client/api/sectors_api.rb, line 39
def add_sectors_with_http_info(korona_account_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SectorsApi.add_sectors ...'
  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 SectorsApi.add_sectors"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SectorsApi.add_sectors"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/sectors'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?

  # header parameters
  header_params = opts[: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 = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Array<AddOrUpdateResult>' 

  # 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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SectorsApi#add_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_sectors(korona_account_id, body, opts = {}) click to toggle source

deletes a batch of sectors @param korona_account_id [String] account id of the KORONA.cloud account @param body [Array<Sector>] array of existing sectors (id or number required) @param [Hash] opts the optional parameters @return [Array<AddOrUpdateResult>]

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

deletes a batch of sectors @param korona_account_id [String] account id of the KORONA.cloud account @param body [Array<Sector>] array of existing sectors (id or number required) @param [Hash] opts the optional parameters @return [Array<(Array<AddOrUpdateResult>, Integer, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers

# File lib/korona-cloud-client/api/sectors_api.rb, line 108
def delete_sectors_with_http_info(korona_account_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SectorsApi.delete_sectors ...'
  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 SectorsApi.delete_sectors"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SectorsApi.delete_sectors"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/sectors'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Array<AddOrUpdateResult>' 

  # 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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SectorsApi#delete_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_sector(korona_account_id, sector_id, opts = {}) click to toggle source

returns the single sector @param korona_account_id [String] account id of the KORONA.cloud account @param sector_id [String] id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Sector]

# File lib/korona-cloud-client/api/sectors_api.rb, line 166
def get_sector(korona_account_id, sector_id, opts = {})
  data, _status_code, _headers = get_sector_with_http_info(korona_account_id, sector_id, opts)
  data
end
get_sector_with_http_info(korona_account_id, sector_id, opts = {}) click to toggle source

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

# File lib/korona-cloud-client/api/sectors_api.rb, line 176
def get_sector_with_http_info(korona_account_id, sector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SectorsApi.get_sector ...'
  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 SectorsApi.get_sector"
  end
  # verify the required parameter 'sector_id' is set
  if @api_client.config.client_side_validation && sector_id.nil?
    fail ArgumentError, "Missing the required parameter 'sector_id' when calling SectorsApi.get_sector"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/sectors/{sectorId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'sectorId' + '}', CGI.escape(sector_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] || 'Sector' 

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

lists all sectors @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 [ResultListSector]

# File lib/korona-cloud-client/api/sectors_api.rb, line 237
def get_sectors(korona_account_id, opts = {})
  data, _status_code, _headers = get_sectors_with_http_info(korona_account_id, opts)
  data
end
get_sectors_with_http_info(korona_account_id, opts = {}) click to toggle source

lists all sectors @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<(ResultListSector, Integer, Hash)>] ResultListSector data, response status code and response headers

# File lib/korona-cloud-client/api/sectors_api.rb, line 252
def get_sectors_with_http_info(korona_account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SectorsApi.get_sectors ...'
  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 SectorsApi.get_sectors"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/sectors'.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] || 'ResultListSector' 

  # 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: SectorsApi#get_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_sectors(korona_account_id, body, opts = {}) click to toggle source

updates a batch of sectors @param korona_account_id [String] account id of the KORONA.cloud account @param body [Array<Sector>] array of existing sectors (id or number required) @param [Hash] opts the optional parameters @return [Array<AddOrUpdateResult>]

# File lib/korona-cloud-client/api/sectors_api.rb, line 310
def update_sectors(korona_account_id, body, opts = {})
  data, _status_code, _headers = update_sectors_with_http_info(korona_account_id, body, opts)
  data
end
update_sectors_with_http_info(korona_account_id, body, opts = {}) click to toggle source

updates a batch of sectors @param korona_account_id [String] account id of the KORONA.cloud account @param body [Array<Sector>] array of existing sectors (id or number required) @param [Hash] opts the optional parameters @return [Array<(Array<AddOrUpdateResult>, Integer, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers

# File lib/korona-cloud-client/api/sectors_api.rb, line 320
def update_sectors_with_http_info(korona_account_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SectorsApi.update_sectors ...'
  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 SectorsApi.update_sectors"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SectorsApi.update_sectors"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/sectors'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Array<AddOrUpdateResult>' 

  # 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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SectorsApi#update_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end