Method: TXTextControl::ReportingCloud::ReportingCloud#delete_api_key

Defined in:
lib/txtextcontrol/reportingcloud/reportingcloud.rb

#delete_api_key(key) ⇒ Object

Deletes a given API Key from the account.

Parameters:

  • key (String) —

    The key to delete from the account.



464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 464

def delete_api_key(key)
  # Parameter validation

  unless !key.nil? && !key.to_s.empty?
    raise ArgumentError, "The given key must not be empty."
  end        

  # Create query parameters

  params = {
    :key => key
  }

  res = request("/account/apikey", :delete, params)
  raise res.body unless res.kind_of? Net::HTTPSuccess
end