Module: KillBillClient

Defined in:
lib/killbill_client.rb,
lib/killbill_client/utils.rb,
lib/rails/killbill_client.rb,
lib/killbill_client/api/api.rb,
lib/killbill_client/version.rb,
lib/killbill_client/api/errors.rb,
lib/killbill_client/models/tag.rb,
lib/killbill_client/models/plan.rb,
lib/killbill_client/models/phase.rb,
lib/killbill_client/models/bundle.rb,
lib/killbill_client/models/credit.rb,
lib/killbill_client/models/models.rb,
lib/killbill_client/models/tenant.rb,
lib/killbill_client/models/account.rb,
lib/killbill_client/models/catalog.rb,
lib/killbill_client/models/invoice.rb,
lib/killbill_client/models/overdue.rb,
lib/killbill_client/models/payment.rb,
lib/killbill_client/models/product.rb,
lib/killbill_client/models/resource.rb,
lib/killbill_client/models/security.rb,
lib/killbill_client/models/audit_log.rb,
lib/killbill_client/models/resources.rb,
lib/killbill_client/models/plan_detail.rb,
lib/killbill_client/models/transaction.rb,
lib/killbill_client/models/custom_field.rb,
lib/killbill_client/models/invoice_item.rb,
lib/killbill_client/models/subscription.rb,
lib/killbill_client/models/usage_record.rb,
lib/killbill_client/api/net_http_adapter.rb,
lib/killbill_client/models/payment_method.rb,
lib/killbill_client/models/tag_definition.rb,
lib/killbill_client/models/invoice_payment.rb,
lib/killbill_client/models/rolled_up_usage.rb,
lib/killbill_client/models/account_timeline.rb,
lib/killbill_client/models/event_subscription.rb,
lib/killbill_client/models/gen/tag_attributes.rb,
lib/killbill_client/models/helpers/tag_helper.rb,
lib/killbill_client/models/gen/plan_attributes.rb,
lib/killbill_client/models/gen/phase_attributes.rb,
lib/killbill_client/models/gen/price_attributes.rb,
lib/killbill_client/models/gen/bundle_attributes.rb,
lib/killbill_client/models/gen/credit_attributes.rb,
lib/killbill_client/models/gen/tenant_attributes.rb,
lib/killbill_client/models/gen/account_attributes.rb,
lib/killbill_client/models/gen/invoice_attributes.rb,
lib/killbill_client/models/gen/payment_attributes.rb,
lib/killbill_client/models/gen/product_attributes.rb,
lib/killbill_client/models/gen/session_attributes.rb,
lib/killbill_client/models/gen/subject_attributes.rb,
lib/killbill_client/models/gen/audit_log_attributes.rb,
lib/killbill_client/models/gen/tenant_key_attributes.rb,
lib/killbill_client/models/gen/plan_detail_attributes.rb,
lib/rails/generators/killbill_client/config_generator.rb,
lib/killbill_client/models/gen/custom_field_attributes.rb,
lib/killbill_client/models/gen/invoice_item_attributes.rb,
lib/killbill_client/models/gen/notification_attributes.rb,
lib/killbill_client/models/gen/subscription_attributes.rb,
lib/killbill_client/models/gen/usage_record_attributes.rb,
lib/killbill_client/models/helpers/custom_field_helper.rb,
lib/killbill_client/models/gen/account_email_attributes.rb,
lib/killbill_client/models/gen/invoice_email_attributes.rb,
lib/killbill_client/models/gen/overdue_state_attributes.rb,
lib/killbill_client/models/gen/catalog_attributes_simple.rb,
lib/killbill_client/models/gen/payment_method_attributes.rb,
lib/killbill_client/models/gen/profiling_data_attributes.rb,
lib/killbill_client/models/gen/rolled_up_unit_attributes.rb,
lib/killbill_client/models/gen/tag_definition_attributes.rb,
lib/killbill_client/models/gen/bundle_timeline_attributes.rb,
lib/killbill_client/models/gen/invoice_dry_run_attributes.rb,
lib/killbill_client/models/gen/invoice_payment_attributes.rb,
lib/killbill_client/models/gen/plugin_property_attributes.rb,
lib/killbill_client/models/gen/rolled_up_usage_attributes.rb,
lib/killbill_client/models/gen/account_timeline_attributes.rb,
lib/killbill_client/models/gen/billing_exception_attributes.rb,
lib/killbill_client/models/gen/unit_usage_record_attributes.rb,
lib/killbill_client/models/gen/event_subscription_attributes.rb,
lib/killbill_client/models/gen/payment_transaction_attributes.rb,
lib/killbill_client/models/gen/profiling_data_attributes_item.rb,
lib/killbill_client/models/gen/stack_trace_element_attributes.rb,
lib/killbill_client/models/gen/gateway_notification_attributes.rb,
lib/killbill_client/models/gen/new_event_subscription_attributes.rb,
lib/killbill_client/models/gen/subscription_usage_record_attributes.rb,
lib/killbill_client/models/gen/deleted_event_subscription_attributes.rb,
lib/killbill_client/models/gen/hosted_payment_page_fields_attributes.rb,
lib/killbill_client/models/gen/invoice_payment_transaction_attributes.rb,
lib/killbill_client/models/gen/hosted_payment_page_customer_attributes.rb,
lib/killbill_client/models/gen/payment_method_plugin_detail_attributes.rb,
lib/killbill_client/models/gen/hosted_payment_page_billing_address_attributes.rb,
lib/killbill_client/models/gen/hosted_payment_page_form_descriptor_attributes.rb

Overview

KillBillClient is a Ruby client for Kill Bill’s REST API.

Defined Under Namespace

Modules: Model, Utils, Version Classes: API, ConfigGenerator, ConfigurationError, Error, Railtie

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Tenant key/secret. Optional.



45
46
47
 
# File 'lib/killbill_client.rb', line 45

def api_key
  @api_key
end

.api_secret ⇒ Object

Returns the value of attribute api_secret.



46
47
48
 
# File 'lib/killbill_client.rb', line 46

def api_secret
  @api_secret
end

.default_currency ⇒ String?

Returns A default currency.

Returns:

  • (String, nil) —

    A default currency.



54
55
56
57
 
# File 'lib/killbill_client.rb', line 54

def default_currency
  return @default_currency if defined? @default_currency
  @default_currency = 'USD'
end

.logger ⇒ Logger?

Assigns a logger to log requests/responses and more.

Examples:

require 'logger'
KillBill.logger = Logger.new STDOUT

Rails applications automatically log to the Rails log:

KillBill.logger = Rails.logger

Turn off logging entirely:

KillBill.logger = nil # Or KillBill.logger = Logger.new nil

Returns:

  • (Logger, nil) 


71
72
73
 
# File 'lib/killbill_client.rb', line 71

def logger
  @logger
end

.password ⇒ Object

Returns the value of attribute password.



51
52
53
 
# File 'lib/killbill_client.rb', line 51

def password
  @password
end

.url ⇒ String

Returns A host.

Returns:

  • (String) —

    A host.



36
37
38
39
40
 
# File 'lib/killbill_client.rb', line 36

def url
  defined? @url and @url or raise(
      ConfigurationError, 'KillBillClient.url not configured'
  )
end

.username ⇒ Object

RBAC username/password. Optional. These can also be configured on a per request basis



50
51
52
 
# File 'lib/killbill_client.rb', line 50

def username
  @username
end

Class Method Details

.log(level, message) ⇒ true?

Convenience logging method includes a Logger#progname dynamically.

Returns:

  • (true, nil) 


75
76
77
 
# File 'lib/killbill_client.rb', line 75

def log(level, message)
  logger.send(level, name) { message }
end

Instance Method Details

#const_defined?(sym, inherit = false) ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (ArgumentError) 


80
81
82
83
 
# File 'lib/killbill_client.rb', line 80

def const_defined?(sym, inherit = false)
  raise ArgumentError, 'inherit must be false' if inherit
  super sym
end

#const_get(sym, inherit = false) ⇒ Object

Raises:

  • (ArgumentError) 


85
86
87
88
 
# File 'lib/killbill_client.rb', line 85

def const_get(sym, inherit = false)
  raise ArgumentError, 'inherit must be false' if inherit
  super sym
end