$darkmode
class for Billwerk.com REST connections; returns BillwerkRestClient::BillwerkRestClient objects More...
Public Member Functions | |
constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}) | |
creates the BillwerkRestConnection object More... | |
hash< auto > | getConstructorOptions (hash< auto > options) |
gets options for the constructor | |
string | getType () |
returns "billwerkrest" | |
Public Attributes | |
const | ConnectionScheme |
Connection entry info. | |
Protected Member Functions | |
hash< ConnectionSchemeInfo > | getConnectionSchemeInfoImpl () |
Returns the ConnectionSchemeInfo hash for this object. | |
BillwerkRestClient | getImpl (bool connect=True, *hash< auto > rtopts) |
returns a BillwerkRestClient::BillwerkRestClient object More... | |
class for Billwerk.com REST connections; returns BillwerkRestClient::BillwerkRestClient objects
In addition to all options supported by RestClientConnection, this connection class supports the following options:
"client_id"
(optional): the billwerk.com client_id"client_secret"
(mandatory): the billwerk.com client_secret"validator"
: an AbstractRestSchemaValidator object for REST message validation (if present, overrides any REST schema validation option provided as a connection option)BillwerkRestClient::BillwerkRestConnection::constructor | ( | string | name, |
string | description, | ||
string | url, | ||
hash< auto > | attributes = {} , |
||
hash< auto > | options = {} |
||
) |
creates the BillwerkRestConnection object
name | the name of the connection |
description | connection description |
url | connection URL (potentially with password info) |
attributes | various attributes. See below |
options | connection options |
See AbstractConnection::constructor() for attributes
and options
reference.
CONNECTION-OPTION-ERROR | missing or invalid connection option |
|
protected |
returns a BillwerkRestClient::BillwerkRestClient object
connect | if True, then the connection is returned already connected |
rtopts | this connection type does not accept any runtime options, so this parameter is ignored |