class KoronaClient::CustomersApi
Attributes
Public Class Methods
# File lib/korona_client/api/customers_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
adds a batch of new customers
@param korona_account_id account id of the KORONA.cloud account @param body array of new customers @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_client/api/customers_api.rb, line 29 def add_customers(korona_account_id, body, opts = {}) data, _status_code, _headers = add_customers_with_http_info(korona_account_id, body, opts) data end
adds a batch of new customers
@param korona_account_id account id of the KORONA.cloud account @param body array of new customers @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>, Fixnum, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
# File lib/korona_client/api/customers_api.rb, line 41 def add_customers_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomersApi.add_customers ...' 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 CustomersApi.add_customers" 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 CustomersApi.add_customers" end # resource path local_var_path = '/accounts/{koronaAccountId}/customers'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s) # query parameters query_params = {} query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].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 = @api_client.object_to_http_body(body) auth_names = ['basicAuth'] 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 => 'Array<AddOrUpdateResult>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomersApi#add_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
deletes the single customer
@param korona_account_id account id of the KORONA.cloud account @param customer_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [nil]
# File lib/korona_client/api/customers_api.rb, line 91 def delete_customer(korona_account_id, customer_id, opts = {}) delete_customer_with_http_info(korona_account_id, customer_id, opts) nil end
deletes the single customer
@param korona_account_id account id of the KORONA.cloud account @param customer_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/korona_client/api/customers_api.rb, line 102 def delete_customer_with_http_info(korona_account_id, customer_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomersApi.delete_customer ...' 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 CustomersApi.delete_customer" end # verify the required parameter 'customer_id' is set if @api_client.config.client_side_validation && customer_id.nil? fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomersApi.delete_customer" end # resource path local_var_path = '/accounts/{koronaAccountId}/customers/{customerId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'customerId' + '}', customer_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(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomersApi#delete_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
deletes a batch of customers
@param korona_account_id account id of the KORONA.cloud account @param body array of existing customers (id or number required) @param [Hash] opts the optional parameters @return [Array<AddOrUpdateResult>]
# File lib/korona_client/api/customers_api.rb, line 150 def delete_customers(korona_account_id, body, opts = {}) data, _status_code, _headers = delete_customers_with_http_info(korona_account_id, body, opts) data end
deletes a batch of customers
@param korona_account_id account id of the KORONA.cloud account @param body array of existing customers (id or number required) @param [Hash] opts the optional parameters @return [Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
# File lib/korona_client/api/customers_api.rb, line 161 def delete_customers_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomersApi.delete_customers ...' 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 CustomersApi.delete_customers" 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 CustomersApi.delete_customers" end # resource path local_var_path = '/accounts/{koronaAccountId}/customers'.sub('{' + 'koronaAccountId' + '}', korona_account_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 = @api_client.object_to_http_body(body) auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:DELETE, 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<AddOrUpdateResult>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomersApi#delete_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
returns the single customer
@param korona_account_id account id of the KORONA.cloud account @param customer_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Customer]
# File lib/korona_client/api/customers_api.rb, line 210 def get_customer(korona_account_id, customer_id, opts = {}) data, _status_code, _headers = get_customer_with_http_info(korona_account_id, customer_id, opts) data end
returns the single customer
@param korona_account_id account id of the KORONA.cloud account @param customer_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Array<(Customer
, Fixnum, Hash)>] Customer
data, response status code and response headers
# File lib/korona_client/api/customers_api.rb, line 221 def get_customer_with_http_info(korona_account_id, customer_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomersApi.get_customer ...' 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 CustomersApi.get_customer" end # verify the required parameter 'customer_id' is set if @api_client.config.client_side_validation && customer_id.nil? fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomersApi.get_customer" end # resource path local_var_path = '/accounts/{koronaAccountId}/customers/{customerId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'customerId' + '}', customer_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 => 'Customer') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomersApi#get_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
lists all customers
@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 [ResultListCustomer]
# File lib/korona_client/api/customers_api.rb, line 275 def get_customers(korona_account_id, opts = {}) data, _status_code, _headers = get_customers_with_http_info(korona_account_id, opts) data end
lists all customers
@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<(ResultListCustomer
, Fixnum, Hash)>] ResultListCustomer
data, response status code and response headers
# File lib/korona_client/api/customers_api.rb, line 291 def get_customers_with_http_info(korona_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomersApi.get_customers ...' 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 CustomersApi.get_customers" end # resource path local_var_path = '/accounts/{koronaAccountId}/customers'.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 => 'ResultListCustomer') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomersApi#get_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
updates the single customer
@param korona_account_id account id of the KORONA.cloud account @param customer_id id of the related object (important: id should match the uuid-format) @param body the properties to update of the customer @param [Hash] opts the optional parameters @return [nil]
# File lib/korona_client/api/customers_api.rb, line 343 def update_customer(korona_account_id, customer_id, body, opts = {}) update_customer_with_http_info(korona_account_id, customer_id, body, opts) nil end
updates the single customer
@param korona_account_id account id of the KORONA.cloud account @param customer_id id of the related object (important: id should match the uuid-format) @param body the properties to update of the customer @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/korona_client/api/customers_api.rb, line 355 def update_customer_with_http_info(korona_account_id, customer_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomersApi.update_customer ...' 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 CustomersApi.update_customer" end # verify the required parameter 'customer_id' is set if @api_client.config.client_side_validation && customer_id.nil? fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomersApi.update_customer" 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 CustomersApi.update_customer" end # resource path local_var_path = '/accounts/{koronaAccountId}/customers/{customerId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'customerId' + '}', customer_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 = @api_client.object_to_http_body(body) auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomersApi#update_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
updates a batch of customers
@param korona_account_id account id of the KORONA.cloud account @param body array of existing customers (id or number required) @param [Hash] opts the optional parameters @return [Array<AddOrUpdateResult>]
# File lib/korona_client/api/customers_api.rb, line 407 def update_customers(korona_account_id, body, opts = {}) data, _status_code, _headers = update_customers_with_http_info(korona_account_id, body, opts) data end
updates a batch of customers
@param korona_account_id account id of the KORONA.cloud account @param body array of existing customers (id or number required) @param [Hash] opts the optional parameters @return [Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
# File lib/korona_client/api/customers_api.rb, line 418 def update_customers_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomersApi.update_customers ...' 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 CustomersApi.update_customers" 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 CustomersApi.update_customers" end # resource path local_var_path = '/accounts/{koronaAccountId}/customers'.sub('{' + 'koronaAccountId' + '}', korona_account_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 = @api_client.object_to_http_body(body) auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:PATCH, 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<AddOrUpdateResult>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomersApi#update_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end