Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.

Commit f798413

Browse files
KaiSchwarz-cnicKaiSchwarz-cnic
committed
reviewed POD docs
1 parent 3c023c9 commit f798413

File tree

11 files changed

+766
-419
lines changed

11 files changed

+766
-419
lines changed

‎docs/apiconnector.html‎

Lines changed: 5 additions & 248 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<!--
66
generated by Pod::Simple::HTML v3.35,
77
using Pod::Simple::PullParser v3.35,
8-
under Perl v5.026000 at Fri Jul 20 16:04:32 2018 GMT.
8+
under Perl v5.026000 at Mon Jul 23 08:27:35 2018 GMT.
99
1010
If you want to change this HTML document, you probably shouldn't do that
1111
by changing it directly. Instead, see about changing the calling options
@@ -72,13 +72,13 @@ <h1><a class='u'
7272
name="DESCRIPTION"
7373
>DESCRIPTION</a></h1>
7474

75-
<p>This module allows the customer to query the API and get different type of response back (list, list_hash, hash)</p>
75+
<p>This module allows to query the API and to deal with different response formats (list, list_hash, hash). It provides a short hand method (HEXONET::Apiconnector::connect) to instantiate API clients.</p>
7676

77-
<p>A helper util module is also included for tasks like date handling and string encoding.</p>
77+
<p>A helper utility module is also included for tasks like date handling and string encoding.</p>
7878

7979
<h1><a class='u'
80-
name="METHODS_HEXONET"
81-
>METHODS HEXONET</a></h1>
80+
name="METHODS_HEXONET::Apiconnector"
81+
>METHODS HEXONET::Apiconnector</a></h1>
8282

8383
<dl>
8484
<dt><a name="connect(url,_entity,_login,_password,_user,_role)"
@@ -89,249 +89,6 @@ <h1><a class='u'
8989
</dd>
9090
</dl>
9191

92-
<h1><a class='u'
93-
name="METHODS_HEXONET::Apiconnector::Connection"
94-
>METHODS HEXONET::Apiconnector::Connection</a></h1>
95-
96-
<dl>
97-
<dt><a name="call(command,_config)"
98-
><code>call(command, config)</code></a></dt>
99-
100-
<dd>
101-
<p>Make a curl API call and returns the response as a response object</p>
102-
103-
<dt><a name="call_raw(command,config)"
104-
><code>call_raw(command,config)</code></a></dt>
105-
106-
<dd>
107-
<p>Make a curl API call and returns the response as a string</p>
108-
109-
<dt><a name="call_raw_http(command,_config)"
110-
><code>call_raw_http(command, config)</code></a></dt>
111-
112-
<dd>
113-
<p>Make a curl API call over HTTP(S) and returns the response as a string</p>
114-
</dd>
115-
</dl>
116-
117-
<h1><a class='u'
118-
name="METHODS_HEXONET::Apiconnector::Response"
119-
>METHODS HEXONET::Apiconnector::Response</a></h1>
120-
121-
<dl>
122-
<dt><a name="as_string()"
123-
><code>as_string()</code></a></dt>
124-
125-
<dd>
126-
<p>Returns the response as a string</p>
127-
128-
<dt><a name="as_hash()"
129-
><code>as_hash()</code></a></dt>
130-
131-
<dd>
132-
<p>Returns the response as a hash</p>
133-
134-
<dt><a name="as_list_hash()"
135-
><code>as_list_hash()</code></a></dt>
136-
137-
<dd>
138-
<p>Returns the response as a list hash</p>
139-
140-
<dt><a name="as_list()"
141-
><code>as_list()</code></a></dt>
142-
143-
<dd>
144-
<p>Returns the response as a list</p>
145-
146-
<dt><a name="code()"
147-
><code>code()</code></a></dt>
148-
149-
<dd>
150-
<p>Returns the response code</p>
151-
152-
<dt><a name="description()"
153-
><code>description()</code></a></dt>
154-
155-
<dd>
156-
<p>Returns the response description</p>
157-
158-
<dt><a name="properties()"
159-
><code>properties()</code></a></dt>
160-
161-
<dd>
162-
<p>Returns the response properties</p>
163-
164-
<dt><a name="runtime()"
165-
><code>runtime()</code></a></dt>
166-
167-
<dd>
168-
<p>Returns the response runtime</p>
169-
170-
<dt><a name="queuetime()"
171-
><code>queuetime()</code></a></dt>
172-
173-
<dd>
174-
<p>Returns the response queutime</p>
175-
176-
<dt><a name="property(index)"
177-
><code>property(index)</code></a></dt>
178-
179-
<dd>
180-
<p>Returns the property for a given index If no index given, the complete property list is returned</p>
181-
182-
<dt><a name="is_success()"
183-
><code>is_success()</code></a></dt>
184-
185-
<dd>
186-
<p>Returns true if the results is a success Success = response code starting with 2</p>
187-
188-
<dt><a name="is_tmp_error()"
189-
><code>is_tmp_error()</code></a></dt>
190-
191-
<dd>
192-
<p>Returns true if the results is a tmp error tmp error = response code starting with 4</p>
193-
194-
<dt><a name="columns()"
195-
><code>columns()</code></a></dt>
196-
197-
<dd>
198-
<p>Returns the columns</p>
199-
200-
<dt><a name="first()"
201-
><code>first()</code></a></dt>
202-
203-
<dd>
204-
<p>Returns the index of the first element</p>
205-
206-
<dt><a name="last()"
207-
><code>last()</code></a></dt>
208-
209-
<dd>
210-
<p>Returns the index of the last element</p>
211-
212-
<dt><a name="count()"
213-
><code>count()</code></a></dt>
214-
215-
<dd>
216-
<p>Returns the number of list elements returned (= last - first + 1)</p>
217-
218-
<dt><a name="limit()"
219-
><code>limit()</code></a></dt>
220-
221-
<dd>
222-
<p>Returns the limit of the response</p>
223-
224-
<dt><a name="total()"
225-
><code>total()</code></a></dt>
226-
227-
<dd>
228-
<p>Returns the total number of elements found (!= count)</p>
229-
230-
<dt><a name="pages()"
231-
><code>pages()</code></a></dt>
232-
233-
<dd>
234-
<p>Returns the number of pages</p>
235-
236-
<dt><a name="page()"
237-
><code>page()</code></a></dt>
238-
239-
<dd>
240-
<p>Returns the number of the current page (starts with 1)</p>
241-
242-
<dt><a name="prevpage()"
243-
><code>prevpage()</code></a></dt>
244-
245-
<dd>
246-
<p>Returns the number of the previous page</p>
247-
248-
<dt><a name="prevpagefirst()"
249-
><code>prevpagefirst()</code></a></dt>
250-
251-
<dd>
252-
<p>Returns the first index for the previous page</p>
253-
254-
<dt><a name="nextpage()"
255-
><code>nextpage()</code></a></dt>
256-
257-
<dd>
258-
<p>Returns the number of the next page</p>
259-
260-
<dt><a name="nextpagefirst()"
261-
><code>nextpagefirst()</code></a></dt>
262-
263-
<dd>
264-
<p>Returns the first index for the next page</p>
265-
266-
<dt><a name="lastpagefirst()"
267-
><code>lastpagefirst()</code></a></dt>
268-
269-
<dd>
270-
<p>Returns the first index for the last page</p>
271-
</dd>
272-
</dl>
273-
274-
<h1><a class='u'
275-
name="METHODS_HEXONET::Apiconnector::Util"
276-
>METHODS HEXONET::Apiconnector::Util</a></h1>
277-
278-
<dl>
279-
<dt><a name="timesql(sqldatetime)"
280-
><code>timesql(sqldatetime)</code></a></dt>
281-
282-
<dd>
283-
<p>Convert the SQL datetime to Unix-Timestamp</p>
284-
285-
<dt><a name="sqltime(timestamp)"
286-
><code>sqltime(timestamp)</code></a></dt>
287-
288-
<dd>
289-
<p>Convert the Unix-Timestamp to a SQL datetime If no timestamp given, returns the current datetime</p>
290-
291-
<dt><a name="url_encode(string)"
292-
><code>url_encode(string)</code></a></dt>
293-
294-
<dd>
295-
<p>URL-encodes string This function is convenient when encoding a string to be used in a query part of a URL</p>
296-
297-
<dt><a name="url_decode(string)"
298-
><code>url_decode(string)</code></a></dt>
299-
300-
<dd>
301-
<p>Decodes URL-encoded string Decodes any %## encoding in the given string.</p>
302-
303-
<dt><a name="base64_encode(string)"
304-
><code>base64_encode(string)</code></a></dt>
305-
306-
<dd>
307-
<p>Encodes data with MIME base64 This encoding is designed to make binary data survive transport through transport layers that are not 8-bit clean, such as mail bodies.</p>
308-
309-
<dt><a name="base64_decode(string)"
310-
><code>base64_decode(string)</code></a></dt>
311-
312-
<dd>
313-
<p>Decodes data encoded with MIME base64</p>
314-
315-
<dt><a name="command_encode(command)"
316-
><code>command_encode(command)</code></a></dt>
317-
318-
<dd>
319-
<p>Encode the command array in a command-string</p>
320-
321-
<dt><a name="response_to_hash(response)"
322-
><code>response_to_hash(response)</code></a></dt>
323-
324-
<dd>
325-
<p>Convert the response string as a hash</p>
326-
327-
<dt><a name="response_to_list_hash(response)"
328-
><code>response_to_list_hash(response)</code></a></dt>
329-
330-
<dd>
331-
<p>Convert the response string as a list hash</p>
332-
</dd>
333-
</dl>
334-
33592
<h1><a class='u'
33693
name="AUTHOR"
33794
>AUTHOR</a></h1>

‎docs/connection.html‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
<html><head><title>HEXONET::Apiconnector::Connection</title>
2+
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" >
3+
</head>
4+
<body class='pod'>
5+
<!--
6+
generated by Pod::Simple::HTML v3.35,
7+
using Pod::Simple::PullParser v3.35,
8+
under Perl v5.026000 at Mon Jul 23 08:27:35 2018 GMT.
9+
10+
If you want to change this HTML document, you probably shouldn't do that
11+
by changing it directly. Instead, see about changing the calling options
12+
to Pod::Simple::HTML, and/or subclassing Pod::Simple::HTML,
13+
then reconverting this document from the Pod source.
14+
When in doubt, email the author of Pod::Simple::HTML for advice.
15+
See 'perldoc Pod::Simple::HTML' for more info.
16+
17+
-->
18+
19+
<!-- start doc -->
20+
<a name='___top' class='dummyTopAnchor' ></a>
21+
22+
<h1><a class='u'
23+
name="NAME"
24+
>NAME</a></h1>
25+
26+
<p>HEXONET::Apiconnector::Connection - package to provide API client functionality.</p>
27+
28+
<h1><a class='u'
29+
name="DESCRIPTION"
30+
>DESCRIPTION</a></h1>
31+
32+
<p>This package provides any API client functionality that you need to communicate with the insanely fast <a href="https://www.hexonet.net/" class="podlinkurl"
33+
>HEXONET Backend API</a>.
34+
A short hand method to instantiate the API client is provided as HEXONET::Apiconnector::connect and its usage is described in that appropriate file.</p>
35+
36+
<p>The API client library itself cares about requesting provided commands to the Backend API by using the given configuration data (credentials,
37+
backend system url and entity) and to return the Backend API response accordingly.</p>
38+
39+
<h1><a class='u'
40+
name="METHODS_HEXONET::Apiconnector::Connection"
41+
>METHODS HEXONET::Apiconnector::Connection</a></h1>
42+
43+
<dl>
44+
<dt><a name="call(command,_config)"
45+
><code>call(command,
46+
config)</code></a></dt>
47+
48+
<dd>
49+
<p>Make a curl API call and returns the response as a response object</p>
50+
51+
<dt><a name="call_raw(command,config)"
52+
><code>call_raw(command,config)</code></a></dt>
53+
54+
<dd>
55+
<p>Make a curl API call and returns the response as a string</p>
56+
57+
<dt><a name="call_raw_http(command,_config)"
58+
><code>call_raw_http(command,
59+
config)</code></a></dt>
60+
61+
<dd>
62+
<p>Make a curl API call over HTTP(S) and returns the response as a string</p>
63+
</dd>
64+
</dl>
65+
66+
<h1><a class='u'
67+
name="AUTHOR"
68+
>AUTHOR</a></h1>
69+
70+
<p>HEXONET GmbH</p>
71+
72+
<p><a href="https://www.hexonet.net" class="podlinkurl"
73+
>https://www.hexonet.net</a></p>
74+
75+
<h1><a class='u'
76+
name="LICENSE"
77+
>LICENSE</a></h1>
78+
79+
<p>MIT</p>
80+
81+
<!-- end doc -->
82+
83+
</body></html>

0 commit comments

Comments
 (0)