Qore BillwerkRestClient Module Reference 1.1
Loading...
Searching...
No Matches
BillwerkRestClient.qm.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* BillwerkRestClient.qm Copyright (C) 2017 - 2024 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23*/
24
25
26
27
28
93
102
103public:
104 const RequiredOptions = ...;
105
106
107 const AuthPath = "/oauth/token";
108
109private:
110 string client_id;
111 string client_secret;
112
113public:
114
116
158 constructor(hash<auto> options, *softbool do_not_connect) ;
159
160
162 static hash<auto> getOptions(hash<auto> options);
163};
164
166
177
178public:
180 const ConnectionScheme = ...;
181
182
185
186
188 const OAuth2Options = ...;
189
190
192 const OAuth2StandardToCdsOptionMap = map {$1.value: $1.key}, OAuth2Options.pairIterator();
193
195 const OAuth2DifferentOptionMap = map {$1.value: $1.key}, OAuth2Options.pairIterator(), $1.key != $1.value;
196
198
208 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
209 ;
210
211
213
230 constructor(hash<auto> config, *hash<auto> attr) ;
231
232
234 string getType();
235
236
238 hash<auto> getConstructorOptions(hash<auto> options);
239
240
242
244 string getOAuth2OptionName(string opt);
245
246
248
250 hash<auto> getOAuth2Options();
251
252
254
259protected:
260 BillwerkRestClient getImpl(bool connect = True, *hash<auto> rtopts);
261public:
262
263
265protected:
266 hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
267public:
268
269};
270};
constructor(hash< auto > options, *softbool do_not_connect)
creates the object with the given options
static hash< auto > getOptions(hash< auto > options)
returns options for the RestClient::constructor()
class for Billwerk.com REST connections; returns BillwerkRestClient::BillwerkRestClient objects
Definition BillwerkRestClient.qm.dox.h:176
hash< auto > getOAuth2Options()
Returns OAuth2 options in a standard format.
const OAuth2DifferentOptionMap
Different OAuth2 option map; standard name => extern name.
Definition BillwerkRestClient.qm.dox.h:195
const ConnectionScheme
Connection entry info.
Definition BillwerkRestClient.qm.dox.h:180
const OAuth2StandardToCdsOptionMap
Maps standard option names to Billwerk REST option names.
Definition BillwerkRestClient.qm.dox.h:192
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
BillwerkRestClient getImpl(bool connect=True, *hash< auto > rtopts)
returns a BillwerkRestClient::BillwerkRestClient object
hash< auto > getConstructorOptions(hash< auto > options)
gets options for the constructor
constructor(hash< auto > config, *hash< auto > attr)
creates the BillwerkRestConnection object
const OAuth2Options
Maps Billwerk REST options to standard options.
Definition BillwerkRestClient.qm.dox.h:188
const OAuth2AuthRequestOptions
options required to support the OAuth2 authorization code grant flow
Definition BillwerkRestClient.qm.dox.h:184
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the BillwerkRestConnection object
string getOAuth2OptionName(string opt)
Returns the OAuth2 option name for this connection.
string getType()
returns "billwerkrest"
the BillwerkRestClient namespace contains all the objects in the BillwerkRestClient module
Definition BillwerkRestClient.qm.dox.h:91