Internal Methods

API for Internal things

internal.echo()

Echo back parsed parameters. Useful for testing.

All parameters are optional.

Parameters:
  • string (String, Optional) – A String
  • list (List, Optional) – A List
  • dictionary (Dictionary, Optional) – A Dictionary
  • boolean (Boolean, Optional) – A Boolean
  • float (Float, Optional) – A Float
  • integer (Integer, Optional) – An Integer
  • date (Date, Optional) – A Date
Returns:

a dictionary of the parsed values with the same names as passed in. If a value wasn’t passed in then a default value for that type will be returned.

internal.noop()

Does nothing. Still does all the authentication though.

Takes no parameters

Returns:an empty dictionary
internal.release()

Returns the API release

Returns:A dictionary with the following keys
release
String: release number, e.g. “0.9.19.”
internal.version()

Returns the API version

Returns:A dictionary with the following keys
version
String: version number, e.g. “0.9”

Previous topic

Firewalling Methods

Next topic

Invoice Methods

This Page