![]() |
Qore BillwerkRestClient Module Reference
1.0
|
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 | |
| *hash< auto > | getDefaultOptions () |
| returns default options | |
| hash< auto > | getOptions () |
| gets options More... | |
| string | getType () |
returns "billwerkrest" | |
Public Attributes | |
| const | BillwerkOptions |
| BillwerkRestConnection object connection options. | |
Protected Member Functions | |
| BillwerkRestClient | getImpl (bool connect=True, *hash< auto > rtopts) |
| returns a BillwerkRestClient::BillwerkRestClient object More... | |
class for Billwerk.com REST connections; returns BillwerkRestClient::BillwerkRestClient objects
supports the following options:
"client_id" (optional): the billwerk.com client_id"client_secret" (mandatory): the billwerk.com client_secret"connect_timeout": connection timeout to use in milliseconds"content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport"data": see RestClient::RestClient::DataSerializationOptions for possible values when used with the null REST schema validator; the default is "auto" "error_passthru": if True then HTTP status codes indicating errors will not cause an HTTP-CLIENT-RECEIVE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response"http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")"max_redirects": maximum redirects to support"proxy": proxy URL to use"send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies"swagger": the path to a Swagger 2.0 REST schema file for runtime API validation (see the Swagger module)"timeout": transfer timeout to use in milliseconds"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.
| BILLWERKRESTCONNECTION-ERROR | missing needed option for Billwerk authentication |
|
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 |
| hash<auto> BillwerkRestClient::BillwerkRestConnection::getOptions | ( | ) |
gets options
"connect_timeout": connection timeout to use in milliseconds"content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport"data": see RestClient::RestClient::DataSerializationOptions for possible values; the default is "json" "error_passthru": if True then HTTP status codes indicating errors will not cause an HTTP-CLIENT-RECEIVE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response"http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")"max_redirects": maximum redirects to support"proxy": proxy URL to use"send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies"timeout": transfer timeout to use in milliseconds