Module: WHMCS

Defined in:
lib/whmcs/version.rb,
lib/whmcs-api.rb,
lib/whmcs/base.rb,
lib/whmcs/misc.rb,
lib/whmcs/order.rb,
lib/whmcs/quote.rb,
lib/whmcs/client.rb,
lib/whmcs/config.rb,
lib/whmcs/domain.rb,
lib/whmcs/module.rb,
lib/whmcs/ticket.rb,
lib/whmcs/invoice.rb,
lib/whmcs/announcement.rb

Overview

:nodoc:

Defined Under Namespace

Classes: Announcement, Base, Client, Config, Domain, Invoice, Misc, Module, Order, Quote, Ticket

Constant Summary collapse

VERSION =
Version = '0.1.2'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configObject

Returns the value of attribute config.



16
17
18
# File 'lib/whmcs-api.rb', line 16

def config
  @config
end

Class Method Details

.configure {|config| ... } ⇒ Object

Pass a block to configure the WHMCS API

WHMCS.configure do |config|
  config.api_username = 'apiuser'
  config.api_password = 'c4ca4238a0b923820dcc509a6f75849b'
  config.api_url      = 'http://example.com/includes/api.php
  config.api_key      = '123nifuasdfasdf97' # if any
end

Yields:



29
30
31
32
# File 'lib/whmcs-api.rb', line 29

def self.configure
  yield config
  config
end