whmcs-api 0.0.2

data/lib/whmcs/misc.rb

@@ -0,0 +1,266 @@
+module WHMCS
+  # The WHMCS::Misc class contains miscelaneous WHMCS API functions
+  class Misc < Base
+
+    # Get activity log
+    #
+    # Optional attributes:
+    #
+    # * <tt>:limitstart</tt> - Which User ID to start at (default = 0)
+    # * <tt>:limitnum</tt> - Limit by number (default = 25)
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Activity_Log
+    def self.get_activity_log(params = {})
+      params.merge!(:action => 'getactivitylog')
+      send_request(params)
+    end
+
+    # Get administrator details
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Admin_Details
+    def self.get_admin_details
+      send_request(:action => 'getadmindetails')
+    end
+
+    # Update administrator notes
+    #
+    # Parameters:
+    #
+    # * <tt>:notes</tt> - notes to enter
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Update_Admin_Notes
+    def self.update_admin_notes(params = {})
+      params.merge!(:action => 'updateadminnotes')
+      send_request(params)
+    end
+
+		# Up To-Do Item
+		#
+		# Parameter:
+		# * <tt>:itemid</tt> - ID of the ToDo in WHMCS to update
+		# * <tt>:adminid</tt> - Admin ID to update the To Do item to
+		#
+		# Optional attributes:
+		# * <tt>:date</tt> - open date of the To Do YYYYMMDD
+		# * <tt>:title</tt> - Title of the to do
+		# * <tt>:description</tt> - Text of the To Do
+		# * <tt>:status</tt> - Status - New, Pending, In Progress, Completed, Postponed
+		# * <tt>:duedate</tt> - due date of the To Do YYYYMMDD
+		#
+		# See:
+		#
+		# http://docs.whmcs.com/API:Update_To-Do_Item
+		def self.update_todo_item(params = {})
+			params.merge!(:action => 'updatetodoitem')
+			send_request(params)
+		end
+
+    # Get allowed currencies
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Currencies
+    def self.get_currencies
+			params.merge!(:action => 'getcurrencies')
+      send_request(params)
+    end
+
+    # Get promotions
+    #
+    # Note: WHMCS has this listed under Misc as well as invoices. It's
+    # aliased here for consistancy with their API docs
+    #
+    # Parameters:
+    #
+    # * <tt>:code</tt> - the specific promotion code to return information for (optional)
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Promotions
+    def self.get_promotions(params = {})
+			params.merge!(:action => 'getpromotions')
+			send_request(params)
+		end
+
+    # Get email templates
+    #
+    # Optional attributes:
+    #
+    # * <tt>:type</tt> - optional - from product,domain,support,general,invoice,affiliate
+    # * <tt>:language</tt> - optional - only required for additional languages
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Email_Templates
+    def self.get_email_templates(params = {})
+      params.merge!(:action => 'getemailtemplates')
+      send_request(params)
+    end
+
+    # Get todo items
+    #
+    # Optional attributes:
+    # * <tt>:status</tt> - optional - from New,Pending,In Progress,Completed,Postponed
+		# * <tt>:limitstart</tt> - where to start the output. Used for pagination. (default = 0)
+		# * <tt>:limitnum</tt> - limit the number of records returned (default = 25)
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_To-Do_Items
+    def self.get_todo_items(params = {})
+      params.merge!(:action => 'gettodoitems')
+      send_request(params)
+    end
+
+    # Get configured todo item statuses
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_To-Do_Items_Statuses
+    def self.get_todo_item_statuses
+      send_request(:action => 'gettodoitemstatuses')
+    end
+
+    # Get staff online
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Staff_Online
+    def self.get_staff_online
+      send_request(:action => 'getstaffonline')
+    end
+
+    # Get stats
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Stats
+    def self.get_stats
+      send_request(:action => 'getstats')
+    end
+
+    # Encrypt a password with the WHMCS algorithm
+    #
+    # Parameters:
+    #
+    # * <tt>:password2</tt> - should contain the string you want encrypting
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Encrypt_Password
+    def self.encrypt_password(params = {})
+      params.merge!(:action => 'encryptpassword')
+      send_request(params)
+    end
+
+    # Decrypt a string with the WHMCS algorithm
+		#
+		# This command is used to decrypt a string using the WHMCS encryption algorithm. 
+		# This cannot be used to decrypt the clients password when using the MD5 Client passwords.
+    #
+    # Parameters:
+    #
+    # * <tt>:password2</tt> - should contain the string you want decrypting
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Decrypt_Password
+    def self.decrypt_password(params = {})
+      params.merge!(:action => 'decryptpassword')
+      send_request(params)
+    end
+
+		# Add Product
+		#
+		# Parameters:
+		# * <tt>:type</tt> one of hostingaccount, reselleraccount, server or other
+		# * <tt>:gid</tt> - the product group ID to add it to
+		# * <tt>:name</tt> - the product name
+		# * <tt>:paytype</tt> - free, onetime or recurring
+		#
+		# Optional attributes:
+		# * <tt>:description</tt> - the product description
+		# * <tt>:hidden</tt> - set true to hide
+		# * <tt>:showdomainoptions</tt> - set true to show
+		# * <tt>:welcomeemail</tt> - the email template ID for a welcome email
+		# * <tt>:qty</tt> - set quantity to enable stock control 
+		# * <tt>:proratadate</tt>
+		# * <tt>:proratachargenextmonth</tt> 
+		# * <tt>:autosetup</tt> - on, payment, order or blank for none
+		# * <tt>:module</tt> - module name
+		# * <tt>:servergroupid</tt> - server group ID
+		# * <tt>:subdomain</tt> - subdomain to offer with product
+		# * <tt>:tax</tt> - set true to apply tax
+		# * <tt>:order</tt> - display sort order to override default
+		# * <tt>:configoption1</tt>
+		# * <tt>:configoption2</tt>
+		# * <tt>:pricing</tt>
+		#
+		# See:
+		#
+		# http://docs.whmcs.com/API:Add_Product
+		def self.add_product(params = {})
+			params.merge!(:action => 'addproduct')
+			send_request(params)
+		end
+
+		# Log Activity
+		#
+		# Parameters:
+		# * <tt>:description</tt> - Text to add to the log
+		# Optional attributes:
+		# * <tt>:userid</tt> - UserID to assign the log to in order to appear in Client Log
+		#
+		# See:
+		#
+		# http://docs.whmcs.com/API:Log_Activity
+		def self.log_activity(params = {})
+			params.merge!(:action => 'logactivity')
+			send_request(params)
+		end
+
+		# Add Banned IP
+		#
+		# Parameters: 
+		# * <tt>:ip</tt> - IP address to ban
+		# Optional attributes:
+		# * <tt>:reason</tt> - reason for ban
+		# * <tt>:days</tt> - number of days to ban for. If not submitted defaults to 7 (not required)
+		# * <tt>:expires</tt> - in YYYY-MM-DD HH:II:SS format eg: 2011-06-06 01:12:34 (optional in place of "days")
+		#
+		# See:
+		#
+		# http://docs.whmcs.com/API:Add_Banned_IP
+		def self.add_banned_ip(params = {})
+			params.merge!(:action => 'addbannedip')
+			send_request(params)
+		end
+
+		# Send Admin Email
+		# This command is used to send an email to Admin users
+		#
+		# Parameters:
+		# * <tt>:messagename</tt> - Name of the Admin email template to send 
+		# * <tt>:mergefields</tt> - array of merge fields to populate the template being sent
+		# * <tt>:type</tt> - Who to send the email to. One of system, account or support. Default: system
+		#
+		# Optional attributes:
+		# * <tt>:customsubject</tt> - Subject for a custommessage being sent
+		# * <tt>:custommessage</tt> - Send a custom email to admin users, this will override 'messagename'
+		# * <tt>:deptid</tt> - If type = support, the users of a department to send email to
+		#
+		# See:
+		#
+		# http://docs.whmcs.com/API:Send_Admin_Email
+		def self.send_admin_email(params = {})
+			params.merge!(:action => 'sendadminemail')
+			send_request(params)
+		end
+  end
+end

data/lib/whmcs/module.rb

@@ -0,0 +1,99 @@
+module WHMCS
+  # WHMCS::Module is the class for working with hosting account modules
+  class Module < Base
+
+    # Run the module create command
+    #
+    # Parameters:
+    #
+    # * <tt>:accountid</tt> - the unique id number of the account in the tblhosting table
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Module_Create
+    def self.module_create(params = {})
+      params.merge!(:action => 'modulecreate')
+      send_request(params)
+    end
+
+    # Run the module suspend command
+    #
+    # Parameters:
+    #
+    # * <tt>:accountid</tt> - the unique id number of the account in the tblhosting table
+		#
+		# Optional attributes:
+    # * <tt>:suspendreason</tt> - an explanation of why the suspension has been made shown to clients & staff
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Module_Suspend
+    def self.module_suspend(params = {})
+      params.merge!(:action => 'modulesuspend')
+      send_request(params)
+    end
+
+    # Run the module unsuspend command
+    #
+    # Parameters:
+    #
+    # * <tt>:accountid</tt> - the unique id number of the account in the tblhosting table
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Module_Unsuspend
+    def self.module_unsuspend(params = {})
+      params.merge!(:action => 'moduleunsuspend')
+      send_request(params)
+    end
+
+    # Run the module terminate command
+    #
+    # Parameters:
+    #
+    # * <tt>:accountid</tt> - the unique id number of the account in the tblhosting table
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Module_Terminate
+    def self.module_terminate(params = {})
+      params.merge!(:action => 'moduleterminate')
+      send_request(params)
+    end
+
+		# Module Change Package
+		#
+		# This command is used to run the change package module command
+		#
+		# Parameters:
+		#
+		# *<tt>:serviceid</tt> - ID of the service in WHMCS to run the module command
+		#
+		# See:
+		#
+		# http://docs.whmcs.com/API:Module_Change_Package
+		def self.module_change_package(params = {})
+			params.merge!(:action => 'modulechangepackage')
+			send_request(params)
+		end
+
+		# Module Change Password
+		#
+		# This command is used to issue the change password command to the module for a service.
+		#
+		# Params:
+		# * <tt>:serviceid</tt> - the unique id of the service to perform the action on (aka tblhosting.id)
+		#
+		# Optional attributes:
+		#
+		# * <tt>:servicepassword</tt> - Specify to update the password on the service before calling
+		#
+		# See:
+		#
+		# http://docs.whmcs.com/API:Module_Change_Password
+		def self.module_change_password(params = {})
+			params.merge!(:action => 'modulechangepw')
+			send_request(params)
+		end
+  end
+end

data/lib/whmcs/order.rb

@@ -0,0 +1,195 @@
+module WHMCS
+  # WHMCS::Order is the class for managing orders
+  class Order < Base
+
+    # Create a new order
+    #
+    # Parameters:
+    #
+    # * <tt>:clientid</tt> - client id for order
+    # * <tt>:pid</tt> - product id
+    # * <tt>:domain</tt> - domain name
+    # * <tt>:billingcycle</tt> - onetime, monthly, quarterly, semiannually, etc..
+    # * <tt>:domaintype</tt> - set for domain registration - register or transfer
+    # * <tt>:regperiod</tt> - 1,2,3,etc...
+    # * <tt>:eppcode</tt> - if transfer
+    # * <tt>:nameserver1</tt> - first nameserver (req for domain reg only)
+    # * <tt>:paymentmethod</tt> - paypal, authorize, etc...
+		#
+		# Optional attributes:
+    # * <tt>:customfields</tt> - a base64 encoded serialized array of custom field values
+    # * <tt>:configoptions</tt> - a base64 encoded serialized array of configurable product options
+		# * <tt>:priceoverride</tt> - allows you to pass in a custom price override for the product
+    # * <tt>:promocode</tt> - pass coupon code to apply to the order (optional)
+		# * <tt>:promooverride</tt> - pass this to override the products a coupon applies to (like through the admin area)
+    # * <tt>:affid</tt> - affiliate ID if you want to assign the order to an affiliate (optional)
+    # * <tt>:noinvoice</tt> - set true to not generate an invoice for this order
+		# * <tt>:noinvoiceemail</tt> - set true to generate but not send the invoice notification email
+    # * <tt>:noemail</tt> - set true to surpress the order confirmation email
+    # * <tt>:clientip</tt> - can be used to pass the customers IP (optional)
+    # * <tt>:addons</tt> - comma seperated list of addon ids
+		#
+		# For VPS/Dedicated Server Orders only:
+		# * <tt>:hostname</tt> - The hostname of the server. This will be added to domain automatically
+		# * <tt>:ns1prefix</tt> - the prefix to be used for the NS1 nameserver
+		# * <tt>:ns2prefix</tt> - the prefix to be used for the NS2 nameserver
+		# * <tt>:rootpw</tt> - The root password for the server
+		#
+		# For Domain registration only:
+		# * <tt>:contactid</tt> - the ID of a contact to use for the domain registrant details
+    # * <tt>:dnsmanagement</tt> - true to enable
+		# * <tt>:domainfields</tt> - a base64 encoded serialized array of the TLD specific field values
+    # * <tt>:emailforwarding</tt> - true to enable
+    # * <tt>:idprotection</tt> - true to enable
+    # * <tt>:nameserver2</tt> - second nameserver
+    # * <tt>:nameserver3</tt> - third nameserver
+    # * <tt>:nameserver4</tt> - fourth nameserver
+    #
+		# For domain renewals:
+		#  * <tt>:domainrenewals</tt> - This is a name -> value array of domain -> regperiod
+		#
+    # See:
+    #
+		# http://docs.whmcs.com/API:Add_Order
+    def self.add_order(params = {})
+      params.merge!(:action => 'addorder')
+      send_request(params)
+    end
+
+    # Get orders
+    #
+    # Optional attributes:
+    # * <tt>:id</tt> - to get a specific order ID only
+		# * <tt>:userid</tt> - to get all orders for a specific client ID
+		# * <tt>:status</tt> - to get all orders in a specific status: Pending, Active, Fraud, Cancelled
+    # * <tt>:limitstart</tt> - The record number to start at (default = 0)
+    # * <tt>:limitnum</tt> - The number of order records to return (default = 25)
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Orders
+    def self.get_orders(params = {})
+      params.merge!(:action => 'getorders')
+      send_request(params)
+    end
+
+    # Get products
+    #
+    # Parameters:
+    #
+    # * <tt>:pid</tt> - can be used to just retrieve the details of a specific product ID
+    # * <tt>:gid</tt> - can be passed to just retrieve products in a specific group
+    # * <tt>:module</tt> - can be passed to just retrieve products assigned to a specific module
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Products
+    def self.get_products(params = {})
+      params.merge!(:action => 'getproducts')
+      send_request(params)
+    end
+
+    # Get promotions
+    #
+    # Optional attributes:
+    #
+    # * <tt>:code</tt> - the specific promotion code to return information for (optional)
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Promotions
+    def self.get_promotions(params = {})
+      params.merge!(:action => 'getpromotions')
+      send_request(params)
+    end
+
+    # Get order statuses
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Order_Statuses
+    def self.get_order_statuses
+      params.merge!(:action => 'getorderstatuses')
+      send_request(params)
+    end
+
+    # Accept an order
+    #
+    # Parameters:
+    #
+    # * <tt>:orderid</tt> - the Order ID
+		#
+		# Optional attributes:
+		# * <tt>:serverid</tt> - the Server ID to provision any hosting products in the order to, overrides default
+		# * <tt>:serviceusername</tt> - the Username to assign for provisioning, overrides default
+		# * <tt>:servicepassword</tt> - the Password to assign for products being provisioned, overrides auto generation
+		# * <tt>:registrar</tt> - the domain registrar module to assign any domains to
+		# * <tt>:autosetup</tt> - true/false - determines whether product provisioning is performed
+		# * <tt>:sendregistrar</tt> - true/false determines whether domain automation is performed
+		# * <tt>:sendemail</tt> - true/false - sets if welcome emails for products and registration confirmation emails for domains should be sent
+    #
+    # See:
+    #
+    # http://docs.whmcs.com/API:Accept_Order
+		def self.accept_order(params = {})
+      params.merge!(:action => 'acceptorder')
+      send_request(params)
+    end
+
+    # Place an order in pending
+    #
+    # Parameters:
+    #
+    # * <tt>:orderid</tt> - the Order ID
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Pending_Order
+    def self.pending_order(params = {})
+      params.merge!(:action => 'pendingorder')
+      send_request(params)
+    end
+
+    # Cancel an order
+    #
+    # Parameters:
+    #
+    # * <tt>:orderid</tt> - the Order ID
+    #
+    # See:
+    #
+    # http://docs.whmcs.com/API:Cancel_Order
+		def self.cancel_order(params = {})
+      params.merge!(:action => 'cancelorder')
+      send_request(params)
+    end
+
+    # Mark an order as fraud
+    #
+    # Parameters:
+    #
+    # * <tt>:orderid</tt> - the Order ID
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Fraud_Order
+    def self.fraud_order(params = {})
+      params.merge!(:action => 'fraudorder')
+      send_request(params)
+    end
+
+    # Delete an order
+    #
+    # Parameters:
+    #
+    # * <tt>:orderid</tt> - the Order ID
+    #
+    # See:
+    #
+    # http://docs.whmcs.com/API:Delete_Order
+		def self.delete_order(params = {})
+      params.merge!(:action => 'deleteorder')
+      send_request(params)
+    end
+  end
+end