class for Billwerk.com REST connections; returns BillwerkRestClient::BillwerkRestClient objects
More...
|
| | constructor (hash< auto > config, *hash< auto > attr) |
| | creates the BillwerkRestConnection object
|
| |
| | constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}) |
| | creates the BillwerkRestConnection object
|
| |
|
hash< auto > | getConstructorOptions (hash< auto > options) |
| | gets options for the constructor
|
| |
| string | getOAuth2OptionName (string opt) |
| | Returns the OAuth2 option name for this connection.
|
| |
| hash< auto > | getOAuth2Options () |
| | Returns OAuth2 options in a standard format.
|
| |
|
string | getType () |
| | returns "billwerkrest"
|
| |
|
|
const | ConnectionScheme = ... |
| | Connection entry info.
|
| |
|
const | OAuth2AuthRequestOptions = ... |
| | options required to support the OAuth2 authorization code grant flow
|
| |
|
const | OAuth2DifferentOptionMap = map {$1.value: $1.key} |
| | Different OAuth2 option map; standard name => extern name.
|
| |
|
const | OAuth2Options = ... |
| | Maps Billwerk REST options to standard options.
|
| |
|
const | OAuth2StandardToCdsOptionMap = map {$1.value: $1.key} |
| | Maps standard option names to Billwerk REST option names.
|
| |
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:
- Note
- additionally supports the following runtime option in getImpl():
"validator": an AbstractRestSchemaValidator object for REST message validation (if present, overrides any REST schema validation option provided as a connection option)
- See also
- BillwerkRestClient::constructor() for more information on the above options
◆ constructor() [1/2]
| BillwerkRestClient::BillwerkRestConnection::constructor |
( |
hash< auto > | config, |
|
|
*hash< auto > | attr ) |
creates the BillwerkRestConnection object
- Parameters
-
| config | with the following keys:
- name (required string): the connection name
- display_name (optional string): the display name
- short_desc (optional string): a short description in plain text
- desc (optional string): a long description with markdown formatting
- url (required string): the connection URL
- opts (optional hash): connection options
- logger (optional LoggerInterface object): logger for the connection
|
| attr | optional connection attributes
- monitor (optional bool): should the connection be monitored? Default: True
- enabled (optional bool): is the connection enabled? Default: True
- locked (optional bool): is the connection locked? Default: False
- debug_data (optional bool): debug data? Default: False
- tags (optional hash): tags for the connection; no default value
|
- Exceptions
-
| CONNECTION-OPTION-ERROR | missing or invalid connection option or attribute |
◆ constructor() [2/2]
| BillwerkRestClient::BillwerkRestConnection::constructor |
( |
string | name, |
|
|
string | description, |
|
|
string | url, |
|
|
hash< auto > | attributes = {}, |
|
|
hash< auto > | options = {} ) |
creates the BillwerkRestConnection object
- Parameters
-
| 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.
- Exceptions
-
| CONNECTION-OPTION-ERROR | missing or invalid connection option |
◆ getImpl()
| BillwerkRestClient BillwerkRestClient::BillwerkRestConnection::getImpl |
( |
bool | connect = True, |
|
|
*hash< auto > | rtopts ) |
|
protected |
◆ getOAuth2OptionName()
| string BillwerkRestClient::BillwerkRestConnection::getOAuth2OptionName |
( |
string | opt | ) |
|
Returns the OAuth2 option name for this connection.
- Since
- CdsRestClient 2.0
◆ getOAuth2Options()
| hash< auto > BillwerkRestClient::BillwerkRestConnection::getOAuth2Options |
( |
| ) |
|
Returns OAuth2 options in a standard format.
- Since
- CdsRestClient 2.0