Class whmcsApi

Index

Constructors

Methods

add call delete get update

Constructors

constructor

new whmcsApi(opts): whmcsApi
Parameters
- opts: WHMCSOptions
Returns whmcsApi
- Defined in lib/client.ts:9

Methods

add

add(action, opts?, cb?): Promise<any>
Calls an Add action on the WHMCS API
Parameters
- action: string
  The action to call
- opts: ModemOptions = {}
  Options for the request
- Optionalcb: Callback
  Callback function
Returns Promise<any>
Promise
- Defined in lib/client.ts:106

call

call(action, opts?, cb?): Promise<any>
Calls an action on the WHMCS API
Parameters
- action: string
  The action to call
- opts: ModemOptions = {}
  Options for the request
- Optionalcb: Callback
  Callback function
Returns Promise<any>
Promise
- Defined in lib/client.ts:74

delete

delete(action, opts?, cb?): Promise<any>
Calls a Delete action on the WHMCS API
Parameters
- action: string
  The action to call
- opts: ModemOptions = {}
  Options for the request
- Optionalcb: Callback
  Callback function
Returns Promise<any>
Promise
- Defined in lib/client.ts:138

get

get(action, opts?, cb?): Promise<any>
Calls a Get action on the WHMCS API
Parameters
- action: string
  The action to call
- opts: ModemOptions = {}
  Options for the request
- Optionalcb: Callback
  Callback function
Returns Promise<any>
Promise
- Defined in lib/client.ts:90

update

update(action, opts?, cb?): Promise<any>
Calls an Update action on the WHMCS API
Parameters
- action: string
  The action to call
- opts: ModemOptions = {}
  Options for the request
- Optionalcb: Callback
  Callback function
Returns Promise<any>
Promise
- Defined in lib/client.ts:122