Class: WHMCS::Order

Inherits:
Base
  • Object
show all
Defined in:
lib/whmcs/order.rb

Overview

WHMCS::Order is the class for managing orders

Class Method Summary collapse

Methods inherited from Base

parse_response, send_request

Class Method Details

.accept_order(params = {}) ⇒ Object

See:

docs.whmcs.com/API:Accept_Order



134
135
136
137
 
# File 'lib/whmcs/order.rb', line 134

def self.accept_order(params = {})
  params.merge!(:action => 'acceptorder')
  send_request(params)
end

.add_order(params = {}) ⇒ Object

docs.whmcs.com/API:Add_Order



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

def self.add_order(params = {})
  params.merge!(:action => 'addorder')
  send_request(params)
end

.cancel_order(params = {}) ⇒ Object

Cancel an order

Parameters:

  • :orderid - the Order ID

See:

docs.whmcs.com/API:Cancel_Order



162
163
164
165
 
# File 'lib/whmcs/order.rb', line 162

def self.cancel_order(params = {})
  params.merge!(:action => 'cancelorder')
  send_request(params)
end

.delete_order(params = {}) ⇒ Object

Delete an order

Parameters:

  • :orderid - the Order ID

See:

docs.whmcs.com/API:Delete_Order



190
191
192
193
 
# File 'lib/whmcs/order.rb', line 190

def self.delete_order(params = {})
  params.merge!(:action => 'deleteorder')
  send_request(params)
end

.fraud_order(params = {}) ⇒ Object

docs.whmcs.com/API:Fraud_Order



176
177
178
179
 
# File 'lib/whmcs/order.rb', line 176

def self.fraud_order(params = {})
  params.merge!(:action => 'fraudorder')
  send_request(params)
end

.get_order_statuses ⇒ Object

docs.whmcs.com/API:Get_Order_Statuses



111
112
113
114
 
# File 'lib/whmcs/order.rb', line 111

def self.get_order_statuses
  params.merge!(:action => 'getorderstatuses')
  send_request(params)
end

.get_orders(params = {}) ⇒ Object

docs.whmcs.com/API:Get_Orders



71
72
73
74
 
# File 'lib/whmcs/order.rb', line 71

def self.get_orders(params = {})
  params.merge!(:action => 'getorders')
  send_request(params)
end

.get_products(params = {}) ⇒ Object

docs.whmcs.com/API:Get_Products



87
88
89
90
 
# File 'lib/whmcs/order.rb', line 87

def self.get_products(params = {})
  params.merge!(:action => 'getproducts')
  send_request(params)
end

.get_promotions(params = {}) ⇒ Object

docs.whmcs.com/API:Get_Promotions



101
102
103
104
 
# File 'lib/whmcs/order.rb', line 101

def self.get_promotions(params = {})
  params.merge!(:action => 'getpromotions')
  send_request(params)
end

.pending_order(params = {}) ⇒ Object

docs.whmcs.com/API:Pending_Order



148
149
150
151
 
# File 'lib/whmcs/order.rb', line 148

def self.pending_order(params = {})
  params.merge!(:action => 'pendingorder')
  send_request(params)
end