whmcs-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6e986d4bb28d588b2c7b31935e004d36bdcb9d7
+  data.tar.gz: a44d73732ff8465d7d6f678482a9033ed9e20212
+SHA512:
+  metadata.gz: e9bb016462637d9aca2f23864ed30f6402293fb70cb5df27ebfd755983527cc468372127f195579a4f5b8f5f3740ac8e938011ef8f97dec53d0ff0c48d2dfe91
+  data.tar.gz: 06e723247c4e86ec384cf05dcd8616853c6ba091709f57aa415dbd6076629414d99fdd32e40fde7881bcc469d6ab4d72fcd2d530f9e3bb663efc1cbf6ac5e8d8

data/README.md

@@ -0,0 +1,37 @@
+# whmcs-ruby
+
+[![Build Status](https://travis-ci.org/jujav4ik/whmcs-api.svg?branch=master)](https://travis-ci.org/jujav4ik/whmcs-api) | [![Coverage Status](https://coveralls.io/repos/jujav4ik/whmcs-api/badge.png)](https://coveralls.io/r/jujav4ik/whmcs-api)
+
+whmcs-api provides Ruby bindings for the [WHMCS API](http://docs.whmcs.com/API#External_API).
+
+
+## Usage
+
+```ruby
+    require 'whmcs-api'
+
+	WHMCS.configure do |config|
+		config.api_url      = 'http://example.com/includes/api.php'
+		config.api_username = 'someusername'
+		config.api_password = 'c4ca4238a0b923820dcc509a6f75849b' # md5 hash
+		# optionally add access key
+		config.api_key = 'YetAnotherAPIAccessKeyForWHMCS'
+
+	end
+
+    WHMCS::Client.get_clients_details(:clientid => '1')
+```
+
+
+
+
+## Useful links
+
+* [Demo Credentials for WHMCS](http://www.whmcs.com/demo/)
+* [WHMCS API](http://docs.whmcs.com/API#External_API)
+
+## Copyright
+
+Copyright (c) 2014 anvyst.com, under MIT License. Have fun!
+
+Copyright (c) 2011 DotBlock.com, see LICENSE in this repo for details.

data/Rakefile

@@ -0,0 +1,17 @@
+$:.unshift 'lib'
+require 'rake/testtask'
+
+# See: http://www.whmcs.com/demo/
+ENV['WHMCS_USER'] = 'Admin'
+ENV['WHMCS_URL']  = 'http://demo.whmcs.com/includes/api.php'
+ENV['WHMCS_PASS'] = 'fe01ce2a7fbac8fafaed7c982a04e229' #md5('demo')
+ENV['WHMCS_KEY']  = 'whmcsdemo'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test' << '.'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+  test.warning = true
+end
+
+task :default => :test

data/lib/whmcs.rb

@@ -0,0 +1,33 @@
+module WHMCS
+  autoload :Version,      "whmcs/version"
+  autoload :Config,       "whmcs/config"
+  autoload :Base,         "whmcs/base"
+  autoload :Client,       "whmcs/client"
+  autoload :Domain,       "whmcs/domain"
+  autoload :Invoice,      "whmcs/invoice"
+  autoload :Misc,         "whmcs/misc"
+  autoload :Module,       "whmcs/module"
+  autoload :Order,        "whmcs/order"
+  autoload :Quote,        "whmcs/quote"
+  autoload :Ticket,       "whmcs/ticket"
+  autoload :Announcement, "whmcs/announcement"
+
+  class << self
+    attr_accessor :config
+  end
+
+  self.config ||= Config.new
+
+  # 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
+  def self.configure
+    yield config
+    config
+  end
+end

data/lib/whmcs/announcement.rb

@@ -0,0 +1,69 @@
+module WHMCS
+	class Announcement < Base
+		# Add Announcement
+    # This command is used to Add a new announcement to the system
+    #
+    # Parameters:
+    # * <tt>:date</tt> - Date of the announcement in format yyyymmdd
+    # * <tt>:title</tt> - Title of the announcement
+    # * <tt>:announcement</tt> - Announcement text
+    # * <tt>:published</tt> - on/off
+    # 
+    # Returns:
+    #  * <tt>:result</tt>
+    #  * <tt>:announcementid</tt>
+    # See:
+    #
+    # http://docs.whmcs.com/API:Add_Announcement
+    def self.add_announcement(params = {})
+      params.merge!(:action => 'addannouncement')
+      send_request(params)
+    end
+
+		# Update Announcement
+    #
+    # Parameters:
+    # * <tt>:announcementid</tt> - ID of the announcement to edit
+    # * <tt>:date</tt> - Date of the announcement in format yyyymmdd
+    # * <tt>:title</tt> - Title of the announcement
+    # * <tt>:announcement</tt> - Announcement text
+    # * <tt>:published</tt> - on/off
+    #
+    # See:
+    #
+    # http://docs.whmcs.com/API:Update_Announcement
+    def self.update_announcement(params = {})
+      params.merge!(:action => 'updateannouncement')
+      send_request(params)
+    end
+
+    # Get Announcements
+    # This command is used to get a list of the announcements in XML format
+    #
+    # Parameters:
+    # * <tt>:limitstart</tt> - used for pagination, start at a certain ID
+    # * <tt>:limitnum</tt> - restrict number of records
+    #
+    # See:
+    #
+    # http://docs.whmcs.com/API:Get_Announcements
+    def self.get_announcements(params ={})
+      params.merge!(:action => 'getannouncements')
+      send_request(params)
+    end
+
+    # Delete Announcement
+    #
+    # Parameters:
+    # * <tt>:announcementid</tt> - The ID of the announcement to delete
+    #
+    # See:
+    #
+    # http://docs.whmcs.com/API:Delete_Announcement
+    def self.delete_announcement(params = {})
+      params.merge!(:action => 'deleteannouncement')
+      send_request(params)
+    end
+  end
+
+end

data/lib/whmcs/base.rb

@@ -0,0 +1,75 @@
+require 'net/http'
+require 'net/https'
+require 'crack'
+
+module WHMCS
+  # WHMCS::Base is the main class used to subclass WHMCS API resources
+  class Base
+
+    # Sends an API request to the WHMCS API
+    #
+    # Parameters:
+    # * <tt>:action</tt> - The API action to perform
+    #
+    # All other paramters are passed along as HTTP POST variables
+    def self.send_request(params = {})
+      if params[:action].empty?
+        raise "No API action set"
+      end
+
+      params.merge!(
+        :username => WHMCS.config.api_username,
+        :password => WHMCS.config.api_password
+      )
+
+      # alternative API access
+      if( !WHMCS.config.api_key.nil? )
+        params.merge!( :accesskey => WHMCS.config.api_key )
+      end
+
+      url = URI.parse(WHMCS.config.api_url)
+
+      http = Net::HTTP.new(url.host, url.port)
+
+      if url.port == 443
+        http.use_ssl = true
+      end
+
+      req = Net::HTTP::Post.new(url.path)
+      req.set_form_data(params)
+      res = http.start { |http| http.request(req) }
+      parse_response(res.body)
+    end
+
+    # Converts the API response to a Hash
+    def self.parse_response(raw)
+      result = {}
+      return result if raw.to_s.empty?
+      
+      if raw.match(/xml version/)
+        Crack::XML.parse(raw)
+      else
+        # in case of password encrypt/decrypt - '=' should be properly parsed
+        raw.split(';').map do |line|
+          m = /^(\w+)\=(.*)$/.match(line)
+          result[ m[1] ] = m[2]
+        end
+        result
+      end
+    end
+  end
+end
+
+# Fix Net::HTTP so we dont get
+# warning: peer certificate won't be verified in this SSL session
+module Net #:nodoc:all
+  class HTTP
+    alias_method :old_initialize, :initialize
+
+    def initialize(*args)
+      old_initialize(*args)
+      @ssl_context = OpenSSL::SSL::SSLContext.new
+      @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+  end
+end

data/lib/whmcs/client.rb

@@ -0,0 +1,607 @@
+module WHMCS
+  # WHMCS::Client is the class for managing clients
+  class Client < Base
+
+	# Create a new client
+	#
+	# Parameters:
+	# * <tt>:firstname</tt>
+	# * <tt>:lastname</tt>
+	# * <tt>:email</tt>
+	# * <tt>:address1</tt>
+	# * <tt>:city</tt>
+	# * <tt>:state</tt>
+	# * <tt>:postcode</tt>
+	# * <tt>:country</tt> - two letter ISO country code
+	# * <tt>:phonenumber</tt>
+	# * <tt>:password2</tt> - password for new user account
+	#
+	# Optional attributes:
+	# * <tt>:companyname</tt>
+	# * <tt>:address2</tt>
+	# * <tt>:currency</tt> - the ID of the currency to set the user to
+	# * <tt>:clientip</tt> - pass the client IP address
+	# * <tt>:language</tt> - the language to assign to the client
+	# * <tt>:groupid</tt>  - used to assign the client to a client group
+	# * <tt>:securityqid</tt> - the ID of the security question for the user
+	# * <tt>:securityqans</tt> - the answer to the client security question
+	# * <tt>:notes</tt>
+	# * <tt>:cctype</tt> - Visa, Mastercard, etc...
+	# * <tt>:cardnum</tt>
+	# * <tt>:expdate</tt>
+	# * <tt>:startdate</tt>
+	# * <tt>:issuenumber</tt>
+	# * <tt>:customfields</tt> - a base64 encoded serialized array of custom field values
+	# * <tt>:noemail</tt> - pass as true to surpress the client signup welcome email sending
+	# * <tt>:skipvalidation</tt> - set true to not validate or check required fields
+	#
+	# *Note*: All client required fields can be optional if "skipvalidation" is passed
+	# See:
+	# http://docs.whmcs.com/API:Add_Client
+	def self.add_client(params = {})
+		params.merge!(:action => 'addclient')
+		send_request(params)
+	end
+
+	# Add Client Note
+	# This command is used to add the Client Note to a specific Client
+	#
+	# Parameters:
+	# * <tt>:userid</tt> - UserID for the note
+	# * <tt>:notes</tt> - The note to add
+	#
+	# See:
+	# http://docs.whmcs.com/API:Add_Client_Note
+	def self.add_client_note(params = {})
+		params.merge!(:action => 'addclientnote')
+		send_request(params)
+	end
+
+	# Close a client account
+	#
+	# Parameters:
+	# * <tt>:clientid</tt>
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Close_Client
+	def self.close_client(params = {})
+		params.merge!(:action => 'closeclient')
+		send_request(params)
+	end
+
+	# Update a client's info
+	# Parameters:
+	# * <tt>:clientid</tt> - Client you wish to update
+	#
+	# Optional attributes:
+	# * <tt>:firstname</tt>
+	# * <tt>:lastname</tt>
+	# * <tt>:companyname</tt>
+	# * <tt>:email</tt>
+	# * <tt>:address1</tt>
+	# * <tt>:address2</tt>
+	# * <tt>:city</tt>
+	# * <tt>:state</tt>
+	# * <tt>:postcode</tt>
+	# * <tt>:country</tt> - two letter ISO country code
+	# * <tt>:phonenumber</tt>
+	# * <tt>:password2</tt>
+	# * <tt>:credit</tt> - credit balance
+	# * <tt>:taxexempt</tt> - true to enable
+	# * <tt>:notes</tt>
+	# * <tt>:cardtype</tt> - visa, mastercard, etc...
+	# * <tt>:cardnum</tt> - cc number
+	# * <tt>:expdate</tt> - cc expiry date
+	# * <tt>:startdate</tt> - cc start date
+	# * <tt>:issuenumber</tt> - cc issue number
+	# * <tt>:language</tt> - default language
+	# * <tt>:status</tt> - active or inactive
+	# * <tt>:latefeeoveride</tt> - true/false
+	# * <tt>:overideduenotices</tt> - true/false
+	# * <tt>:separateinvoices</tt> - true/false
+	# * <tt>:disableautocc</tt> - true/false
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Update_Client
+	def self.update_client(params = {})
+		params.merge!(:action => 'updateclient')
+		send_request(params)
+	end
+
+	# Update Client Addon
+	#
+	# Parameters:
+	#
+	# * <tt>:id</tt> - ID of addon to update tblhostingaddons.id
+	#
+	# Optional attributes:
+	#
+	# * <tt>:addonid</tt> - Update the defined addon id - tbladdons.id
+	# * <tt>:name</tt> - Custom name to define for the addon
+	# * <tt>:setupfee</tt> - Setup fee cost. No symbol,i.e xx.xx
+	# * <tt>:recurring</tt> - Setup fee cost. No symbol,i.e xx.xx
+	# * <tt>:billingcycle</tt> - One of Free Account, One Time, Monthly, Quarterly, Semi-Annually, Annually, Biennially or Triennially
+	# * <tt>:nextduedate</tt> - Update the next due date yyyymmdd
+	# * <tt>:nextinvoicedate</tt> - Update the next invoice date yyyymmdd
+	# * <tt>:notes</tt> - add custom notes to the addon
+	# * <tt>:status</tt> - Pending, Active, Suspended, Cancelled, Terminated, Fraud
+	#
+	# See:
+	# http://docs.whmcs.com/API:Update_Client_Addon
+	def self.update_client_addon(params = {})
+		params.merge!(:action => 'updateclientaddon')
+		send_request(params)
+	end
+
+	# Update Client Domain
+	#
+	# Parameters:
+	# * <tt>:domainid</tt> - ID of domain to update tbldomains.id
+	# * <tt>:domain</tt> - instead of domainid
+	#
+	# Optional attributes:
+	# * <tt>:type</tt> - Register or Transfer
+	# * <tt>:autorecalc</tt> - automatically recalculate the recurring price. Will override recurringamount
+	# * <tt>:regdate</tt> - Update the reg date yyyymmdd
+	# * <tt>:domain</tt> - Update the domain name
+	# * <tt>:firstpaymentamount</tt> - Set the first payment amount. No symbol, i.e xx.xx
+	# * <tt>:recurringamount</tt> - Setup fee cost. No symbol, i.e xx.xx
+	# * <tt>:registrar</tt> - Update the registrar assigned to the domain
+	# * <tt>:billingcycle</tt> - One of Free Account, One Time, Monthly, Quarterly, Semi-Annually, Annually, Biennially or Triennially
+	# * <tt>:status</tt> - One of Active, Pending, Pending Transfer, Expired, Cancelled, Fraud
+	# * <tt>:nextduedate</tt> - Update the next due date yyyymmdd
+	# * <tt>:nextinvoicedate</tt> - Update the next invoice date yyyymmdd
+	# * <tt>:expirydate</tt> - Update the expiry date yyyymmdd
+	# * <tt>:regperiod</tt> - Update the reg period for the domain. 1-10
+	# * <tt>:paymentmethod</tt> - set the payment method
+	# * <tt>:subscriptionid</tt> - allocate a subscription ID
+	# * <tt>:dnsmanagement</tt> - enable/disable DNS Management
+	# * <tt>:emailforwarding</tt> - enable/disable Email Forwarding
+	# * <tt>:idprotection</tt> - enable/disable ID Protection status
+	# * <tt>:donotrenew</tt> - enable/disable Do Not Renew
+	# * <tt>:updatens</tt> - Set to true to update Nameservers
+	# * <tt>:nsX</tt>	- X should be 1-5, nameservers to send. Minimum 1&2 required
+	# * <tt>:notes</tt> -  add custom notes to the addon
+	#
+	# See: 
+	# http://docs.whmcs.com/API:Update_Client_Domain
+	def self.update_client_domain(params = {})
+		params.merge!(:action => 'updateclientdomain')
+		send_request(params)
+	end
+
+
+	# Delete a client
+	#
+	# Parameters:
+	#
+	# * <tt>:clientid</tt> - ID Number of the client to delete
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Delete_Client
+	def self.delete_client(params = {})
+		params.merge!(:action => 'deleteclient')
+		send_request(params)
+	end
+
+	# Get multiple clients
+	#
+	# Parameters:
+	#
+	# * <tt>:limitstart</tt> - Record to start at (default = 0)
+	# * <tt>:limitnum</tt> - Number of records to return (default = 25)
+	# * <tt>:search</tt> - Can be passed to filter for clients with a name/email matching the term entered
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Get_Clients
+	def self.get_clients(params = {})
+		params.merge!(:action => 'getclients')
+		send_request(params)
+	end
+
+	# Get Client Credits
+	#
+	# Parameters:
+	# * <tt>:clientid</tt>
+	#
+	# See:
+	# http://docs.whmcs.com/API:Get_Credits
+	def self.get_credits(params = {})
+		params.merge!(:action => 'getcredits')
+		send_request(params)
+	end
+
+	# Get Clients Addons
+	#
+	# Parameters:
+	# * <tt>:clientid</tt> - The Client ID you wish to obtain the results for
+	# * <tt>:addonid</tt> - The specific addonid you wish to find
+	# * <tt>:serviceid</tt> - The specific, or comma separated list of, service(s)
+	#
+	# See:
+	# http://docs.whmcs.com/API:Get_Clients_Addons
+	def get_clients_addons(params = {})
+		params.merge!(:action => 'getclientsaddons')
+		send_request(params)
+	end
+
+	# Get a client's info
+	#
+	# Parameters:
+	#
+	# * <tt>:clientid</tt> - the id number of the client
+	# * <tt>:email</tt> - the email address of the client
+	#
+	# Optional attributes:
+	# * <tt>:stats</tt> - true - If the responsetype of your API call is not XML, 
+	# stats are not returned unless this variable is passed
+	#
+	# See:
+	# http://docs.whmcs.com/API:Get_Clients_Details
+	def self.get_clients_details(params = {})
+		params.merge!(:action => 'getclientsdetails')
+		send_request(params)
+	end
+
+	# Get a hash of a client's password
+	#
+	# Parameters:
+	# * <tt>:userid</tt> - should contain the user id of the client you wish to get the password for
+	#
+	# Optional attributes:
+	# * <tt>:email</tt> - send email address instead of userid
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Get_Clients_Password
+	def self.get_clients_password(params = {})
+		params.merge!(:action => 'getclientpassword')
+		send_request(params)
+	end
+
+	# Add a client contact
+	#
+	# Parameters:
+	#
+	# * <tt>:clientid</tt> - the client ID to add the contact to
+	#
+	# Optional attributes:
+	# * <tt>:firstname</tt>
+	# * <tt>:lastname</tt>
+	# * <tt>:companyname</tt>
+	# * <tt>:email</tt>
+	# * <tt>:address1</tt>
+	# * <tt>:address2</tt>
+	# * <tt>:city</tt>
+	# * <tt>:state</tt>
+	# * <tt>:postcode</tt>
+	# * <tt>:country</tt> - two letter ISO country code
+	# * <tt>:phonenumber</tt>
+	# * <tt>:password2</tt> - if creating a sub-account
+	# * <tt>:permissions</tt> - can specify sub-account permissions eg manageproducts,managedomains
+	# * <tt>:generalemails</tt> - set true to receive general email types
+	# * <tt>:productemails</tt> - set true to receive product related emails
+	# * <tt>:domainemails</tt> - set true to receive domain related emails
+	# * <tt>:invoiceemails</tt> - set true to receive billing related emails
+	# * <tt>:supportemails</tt> - set true to receive support ticket related emails
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Add_Contact
+	def self.add_contact(params = {})
+		params.merge!(:action => 'addcontact')
+		send_request(params)
+	end
+
+	# Add Cancel Request
+	# This command is used to Add Cancellation Request for a specific product
+	#
+	# Parameters:
+	# * <tt>:serviceid</tt> - Service ID to be cancelled
+	# * <tt>:type</tt> - 'Immediate' OR 'End of Billing Period'
+	#
+	# Optional attributes:
+	# * <tt>:reason</tt> - Reason for cancel
+	#
+	# See: 
+	# http://docs.whmcs.com/API:Add_Cancel_Request
+	def self.add_cancel_request(params = {})
+		params.merge!(:action => 'addcancelrequest')
+		send_request(params)
+	end
+
+	# Get client's contacts
+	#
+	# Optional attributes:
+	#
+	# * <tt>:limitstart</tt> - Record to start at (default = 0)
+	# * <tt>:limitnum</tt> - Number of records to return (default = 25)
+	# * <tt>:userid</tt>
+	# * <tt>:firstname</tt>
+	# * <tt>:lastname</tt>
+	# * <tt>:companyname</tt>
+	# * <tt>:email</tt>
+	# * <tt>:address1</tt>
+	# * <tt>:address2</tt>
+	# * <tt>:city</tt>
+	# * <tt>:state</tt>
+	# * <tt>:postcode</tt>
+	# * <tt>:country</tt>
+	# * <tt>:phonenumber</tt>
+	# * <tt>:subaccount</tt> - true/false
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Get_Contacts
+	def self.get_contacts(params = {})
+		params.merge!(:action => 'getcontacts')
+		send_request(params)
+	end
+
+	# Update a client's contact
+	#
+	# Parameters:
+	#
+	# * <tt>:contactid</tt> - The ID of the contact to delete
+	# 
+	# Optional attributes:
+	# * <tt>:generalemails</tt> - set to true to receive general emails
+	# * <tt>:productemails</tt> - set to true to receive product emails
+	# * <tt>:domainemails</tt> - set to true to receive domain emails
+	# * <tt>:invoiceemails</tt> - set to true to receive invoice emails
+	# * <tt>:supportemails</tt> - set to true to receive support emails
+	# * <tt>:firstname</tt> - change the firstname
+	# * <tt>:lastname</tt> - change the lastname
+	# * <tt>:companyname</tt> - change the companyname
+	# * <tt>:email</tt> - change the email address
+	# * <tt>:address1</tt> - change address1
+	# * <tt>:address2</tt> - change address2
+	# * <tt>:city</tt> - change city
+	# * <tt>:state</tt> - change state
+	# * <tt>:postcode</tt> - change postcode
+	# * <tt>:country</tt> - change country
+	# * <tt>:phonenumber</tt> - change phonenumber
+	# * <tt>:subaccount</tt> - enable subaccount
+	# * <tt>:password2</tt> - change the password
+	# * <tt>:permissions</tt> - set permissions eg manageproducts,managedomains
+	#
+	# Only send fields you wish to update
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Update_Contact
+	def self.update_contact(params = {})
+		params.merge!(:action => 'updatecontact')
+		send_request(params)
+	end
+
+	# Upgrade Product
+	#
+	# This command allows you to calculate the cost for an upgrade or downgrade of a product/service, and create an order for it.
+	#
+	# Parameters:
+	# * <tt>:clientid</tt> - the client ID to be upgraded
+	# * <tt>:serviceid</tt> - the service ID to be upgraded
+	# * <tt>:type</tt> - either "product" or "configoptions"
+	# * <tt>:newproductid</tt> - if upgrade type = product, the new product ID to upgrade to
+	# * <tt>:newproductbillingcycle</tt> - monthly, quarterly, etc...
+	# * <tt>:configoptions[x]</tt> - if upgrade type = configoptions, an array of config options
+	# * <tt>:paymentmethod</tt> - the payment method for the order (paypal, authorize, etc...)
+	#
+	# Optional attributes:
+	# * <tt>:promocode</tt> - associate a promotion code with the upgrade
+	# * <tt>:calconly</tt> - set true to validate upgrade and get price, false to actually create order
+	# * <tt>:ordernotes</tt> - any admin notes to add to the order
+	# See:
+	#
+	# http://docs.whmcs.com/API:Upgrade_Product
+	def self.upgrade_product(params = {})
+		params.merge!(:action => 'upgradeproduct')
+		send_request(params)
+	end
+
+
+	# Delete a client's contact
+	#
+	# Parameters:
+	#
+	# * <tt>:contactid</tt> - The ID of the contact to delete
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Delete_Contact
+	def self.delete_contact(params = {})
+		params.merge!(:action => 'deletecontact')
+		send_request(params)
+	end
+
+	# Get client's products
+	#
+	# Optional attributes:
+	#
+	# * <tt>:clientid</tt> - the ID of the client to retrieve products for
+	# * <tt>:serviceid</tt> - the ID of the service to retrieve details for
+	# * <tt>:domain</tt> - the domain of the service to retrieve details for
+	# * <tt>:pid</tt> - the product ID of the services to retrieve products for
+	# * <tt>:username2</tt> - the service username to retrieve details for
+	# * <tt>:limitstart</tt> - where to start the records. Used for pagination
+	# * <tt>:limitnum</tt> - the number of records to retrieve. Default = 999999
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Get_Clients_Products
+	def self.get_clients_products(params = {})
+		params.merge!(:action => 'getclientsproducts')
+		send_request(params)
+	end
+
+	# Get Clients Domains
+	#
+	# * <tt>:clientid</tt> - the ID of the client to retrieve products for
+	#
+	# Optional attributes:
+	# * <tt>:domainid</tt> - the ID of the domain to retrieve details for
+	# * <tt>:domain</tt> - the domain of the service to retrieve details for
+	# * <tt>:limitstart</tt> - where to start the records. Used for pagination
+	# * <tt>:limitnum</tt> - the number of records to retrieve. Default = 25
+	# * <tt>:getnameservers</tt> - retrieve nameservers in the response
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Get_Clients_Domains
+	def self.get_clients_domains(params = {})
+		params.merge!(:action => 'getclientsdomains')
+		send_request(params)
+	end
+
+	# Update client's product
+	#
+	# Parameters:
+	#
+	# * <tt>:serviceid</tt> - the ID of the service to be updated
+	#
+	# Optional attributes:
+	# * <tt>:pid</tt>
+	# * <tt>:serverid</tt>
+	# * <tt>:regdate</tt> - Format: YYYY-MM-DD
+	# * <tt>:nextduedate</tt> - Format: YYYY-MM-DD
+	# * <tt>:domain</tt>
+	# * <tt>:firstpaymentamount</tt>
+	# * <tt>:recurringamount</tt>
+	# * <tt>:billingcycle</tt>
+	# * <tt>:paymentmethod</tt>
+	# * <tt>:status</tt>
+	# * <tt>:serviceusername</tt>
+	# * <tt>:servicepassword</tt>
+	# * <tt>:subscriptionid</tt>
+	# * <tt>:promoid</tt>
+	# * <tt>:overideautosuspend</tt> - on/off
+	# * <tt>:overidesuspenduntil</tt> - Format: YYYY-MM-DD
+	# * <tt>:ns1</tt>
+	# * <tt>:ns2</tt>
+	# * <tt>:dedicatedip</tt>
+	# * <tt>:assignedips</tt>
+	# * <tt>:notes</tt>
+	# * <tt>:autorecalc</tt> - pass true to auto set price based on product ID or billing cycle change
+	# * <tt>:customfields</tt> - a base64 encoded serialized array of custom field values
+	# * <tt>:configoptions</tt> - a base64 encoded serialized array of configurable options values
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Update_Client_Product
+	def self.update_client_product(params = {})
+		params.merge!(:action => 'updateclientproduct')
+		send_request(params)
+	end
+
+	# Validate client login info
+	#
+	# Parameters:
+	#
+	# * <tt>:email</tt> - the email address of the user trying to login
+	# * <tt>:password2</tt> - the password they supply for authentication
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Validate_Login
+	def self.validate_login(params = {})
+		params.merge!(:action => 'validatelogin')
+		send_request(params)
+	end
+
+	# Send email to client
+	#
+	# Parameters:
+	#
+	# * <tt>:messagename</tt> - unique name of the email template to send from WHMCS
+	# * <tt>:id</tt> - related ID number to send message for 
+	# (for a general email type a client ID, for a product email type the products Service ID, etc...)
+	#
+	# Optional attributes:
+	# * <tt>:customtype</tt> - The type of email: general, product, domain or invoice
+	# * <tt>:customsubject</tt> - Subject for the custom email being sent
+	# * <tt>:custommessage</tt> - Content to send as an email, this will override 'messagename' if set
+	# * <tt>:customvars</tt> - serialized base64 encoded array of custom variables
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Send_Email
+	def self.send_email(params = {})
+		params.merge!(:action => 'sendemail')
+		send_request(params)
+	end
+
+	# Get Emails
+	# This command is used to get a list of the client emails in XML format
+	#
+	# Parameters:
+	# * <tt>:clientid</tt> - ID of the client to obtain the credit list for
+	#
+	# Optional attributes:
+	# * <tt>:date</tt> - date to obtain emails for. Can be YYYYMMDD, YYYYMM, MMDD, DD or MM
+	# * <tt>:subject</tt> - to obtain email with a specific subject
+	# * <tt>:limitstart</tt> - for pagination, specify an ID to start at (default = 0)
+	# * <tt>:limitnum</tt> - to restrict the number of results returned (default = 25)
+	def self.get_emails(params = {})
+		params.merge!(:action => 'getemails')
+		send_request(params)
+	end
+
+
+	# Get Transactions
+	# This command is used to obtain an XML list of transactions from your WHMCS
+	#
+	# Optional attributes:
+	# * <tt>:clientid</tt> - User ID to obtain details for
+	# * <tt>:invoiceid</tt> - Obtain transactions for a specific invoice
+	# * <tt>:transid</tt> - Obtain details for a specific transaction ID
+	#
+	# See:
+	# http://docs.whmcs.com/API:Get_Transactions
+	def self.get_transactions(params = {})
+		params.merge!(:action => 'gettransactions')
+		send_request(params)
+	end
+
+
+	# Get Quotes
+	#
+	# Parameters:
+	# * <tt>:userid</tt>
+	#
+	# Optional attributes:
+	# * <tt>:quoteid</tt> - specific quote to obtain
+	# * <tt>:userid</tt> - obtain quotes for a specific user
+	# * <tt>:datecreated</tt> - Format YYYYMMDD
+	# * <tt>:astmodified</tt> - Format YYYYMMDD
+	# * <tt>:validuntil</tt> - Format YYYYMMDD
+	# * <tt>:stage</tt>	- Specific stage to retrieve quotes for
+	# * <tt>:subject</tt> - to obtain quotes with a specific subject
+	# * <tt>:limitstart</tt> - for pagination, specify an ID to start at
+	# * <tt>:limitnum</tt> - to restrict the number of results returned
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Get_Quotes
+	def self.get_quotes(params = {})
+		params.merge!(:action => 'getquotes')
+		send_request(params)
+	end
+
+	# Get Client Groups
+	#
+	# This command is used to get a list of the client groups in XML format
+	#
+	# See:
+	#
+	# http://docs.whmcs.com/API:Get_Client_Groups
+	def self.get_client_groups
+		send_request(:action => 'getclientgroups')
+	end
+
+  end
+end