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 - 2022 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}
29
94
103
104public:
105 const RequiredOptions = ...;
106
107
108 const AuthPath = "/oauth/token";
109
110private:
111 string username;
112 string password;
113 string client_id;
114 string client_secret;
115
116public:
117
119
161 constructor(hash<auto> options, *softbool do_not_connect) ;
162
163
165 static hash<auto> getOptions(hash<auto> options);
166
168protected:
170public:
171
172};
173
175
197
198public:
200 const ConnectionScheme = <ConnectionSchemeInfo>{
201 "cls": Class::forName("BillwerkRestConnection"),
202 "options": RestConnection::ConnectionScheme.options + {
203 "client_id": <ConnectionOptionInfo>{
204 "type": "string",
205 "desc": "the client ID",
206 },
207 "client_secret": <ConnectionOptionInfo>{
208 "type": "string",
209 "desc": "the client secret",
210 },
211 },
212 "required_options": foldl $1 + "," + $2, BillwerkRestClient::RequiredOptions,
213 };
214
216
226 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
227 ;
228
229
231 string getType();
232
233
235 hash<auto> getConstructorOptions(hash<auto> options);
236
237
239
244protected:
245 BillwerkRestClient getImpl(bool connect = True, *hash<auto> rtopts);
246public:
247
248
250protected:
251 hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
252public:
253
254};
255};
getToken()
logs in an sets the token for further communication
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:196
const ConnectionScheme
Connection entry info.
Definition: BillwerkRestClient.qm.dox.h:200
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(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the BillwerkRestConnection object
string getType()
returns "billwerkrest"
the BillwerkRestClient namespace contains all the objects in the BillwerkRestClient module
Definition: BillwerkRestClient.qm.dox.h:92