$darkmode
this class provides the REST client API for communication with the billwerk.com platform More...
Public Member Functions | |
| constructor (hash< auto > options, *softbool do_not_connect) | |
| creates the object with the given options More... | |
Static Public Member Functions | |
| static hash< auto > | getOptions (hash< auto > options) |
| returns options for the RestClient::constructor() | |
this class provides the REST client API for communication with the billwerk.com platform
This class requires one of the following options for billwerk.com's authentication and authorization:
client_secret: the billwerk.com's client_secrettoken: the billwerk.com's token, if provided then the HTTP username, password, and client_secret are not needed and will be ignored.After connecting, the BillwerkRestClient class will request a session token that will be used in further communication.
| BillwerkRestClient::BillwerkRestClient::constructor | ( | hash< auto > | options, |
| *softbool | do_not_connect | ||
| ) |
creates the object with the given options
| options | valid options are:
|
| do_not_connect | if False (the default), then a connection will be immediately established to the remote server |
| RESTCLIENT-ERROR | invalid option passed to constructor, unsupported data serialization, etc |
| BILLWERKRESTCLIENT-ERROR | missing or invalid required option for Billwerk.com REST authentication or communication |