fattura24 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -21,7 +21,6 @@
21
21
  <link href="../../css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
24
  <body id="top" role="document" class="class">
26
25
  <nav role="navigation">
27
26
  <div id="project-navigation">
@@ -58,34 +57,27 @@
58
57
 
59
58
  <div id="class-metadata">
60
59
 
61
- <div id="parent-class-section" class="nav-section">
60
+
61
+ <div id="parent-class-section" class="nav-section">
62
62
  <h3>Parent</h3>
63
63
 
64
-
65
64
  <p class="link">Object
66
-
67
65
  </div>
68
66
 
69
67
 
70
68
 
71
- <!-- Method Quickref -->
69
+
70
+ <!-- Method Quickref -->
72
71
  <div id="method-list-section" class="nav-section">
73
72
  <h3>Methods</h3>
74
73
 
75
74
  <ul class="link-list" role="directory">
76
-
77
75
  <li ><a href="#method-c-new">::new</a>
78
-
79
76
  <li ><a href="#method-i-code">#code</a>
80
-
81
77
  <li ><a href="#method-i-pdf-3F">#pdf?</a>
82
-
83
78
  <li ><a href="#method-i-success-3F">#success?</a>
84
-
85
79
  <li ><a href="#method-i-to_h">#to_h</a>
86
-
87
80
  <li ><a href="#method-i-to_s">#to_s</a>
88
-
89
81
  </ul>
90
82
  </div>
91
83
 
@@ -103,21 +95,15 @@
103
95
 
104
96
  </section>
105
97
 
106
-
107
98
  <section id="5Buntitled-5D" class="documentation-section">
108
-
109
99
 
110
-
111
100
 
112
-
113
101
 
114
-
115
102
  <section class="attribute-method-details" class="method-section">
116
103
  <header>
117
104
  <h3>Attributes</h3>
118
105
  </header>
119
106
 
120
-
121
107
  <div id="attribute-i-http_response" class="method-detail">
122
108
  <div class="method-heading attribute-method-heading">
123
109
  <span class="method-name">http_response</span><span
@@ -125,180 +111,118 @@
125
111
  </div>
126
112
 
127
113
  <div class="method-description">
128
-
129
114
  <p>When needed, you can directly access the underlying <a href="https://ruby-doc.org/stdlib-2.7.0/libdoc/net/http/rdoc/Net/HTTP.html">Net::HTTP</a> response by calling this method.</p>
130
-
131
115
  </div>
132
116
  </div>
133
-
134
117
  </section>
135
-
136
118
 
137
-
119
+
138
120
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
139
121
  <header>
140
122
  <h3>Public Class Methods</h3>
141
123
  </header>
142
124
 
143
-
144
125
  <div id="method-c-new" class="method-detail ">
145
-
146
126
  <div class="method-heading">
147
127
  <span class="method-name">new</span><span
148
128
  class="method-args">(http_response)</span>
149
-
150
129
  <span class="method-click-advice">click to toggle source</span>
151
-
152
130
  </div>
153
-
154
131
 
155
132
  <div class="method-description">
156
133
 
157
-
158
-
159
-
160
134
 
161
-
162
135
  <div class="method-source-code" id="new-source">
163
136
  <pre><span class="ruby-comment"># File lib/fattura24/api/response.rb, line 16</span>
164
137
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">http_response</span>)
165
138
  <span class="ruby-ivar">@http_response</span> = <span class="ruby-identifier">http_response</span>
166
139
  <span class="ruby-keyword">end</span></pre>
167
140
  </div>
168
-
169
141
  </div>
170
142
 
171
-
172
143
 
173
-
174
144
  </div>
175
145
 
176
-
177
146
  </section>
178
-
147
+
179
148
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
180
149
  <header>
181
150
  <h3>Public Instance Methods</h3>
182
151
  </header>
183
152
 
184
-
185
153
  <div id="method-i-code" class="method-detail ">
186
-
187
154
  <div class="method-heading">
188
155
  <span class="method-name">code</span><span
189
156
  class="method-args">()</span>
190
-
191
157
  <span class="method-click-advice">click to toggle source</span>
192
-
193
158
  </div>
194
-
195
159
 
196
160
  <div class="method-description">
197
-
198
161
  <p>Returns the <code>Integer</code> value of the underlying http request. It does not mean the request performed it&#39;s intended purpose. Make sure you use <a href="Response.html#method-i-to_s"><code>to_s</code></a> or <a href="Response.html#method-i-to_h"><code>to_h</code></a> to explore the actual body of the response.</p>
199
-
200
-
201
162
 
202
-
203
163
  <div class="method-source-code" id="code-source">
204
164
  <pre><span class="ruby-comment"># File lib/fattura24/api/response.rb, line 32</span>
205
165
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">code</span>
206
166
  <span class="ruby-identifier">http_response</span>&amp;.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
207
167
  <span class="ruby-keyword">end</span></pre>
208
168
  </div>
209
-
210
169
  </div>
211
170
 
212
-
213
171
 
214
-
215
172
  </div>
216
173
 
217
-
218
174
  <div id="method-i-pdf-3F" class="method-detail ">
219
-
220
175
  <div class="method-heading">
221
176
  <span class="method-name">pdf?</span><span
222
177
  class="method-args">()</span>
223
-
224
178
  <span class="method-click-advice">click to toggle source</span>
225
-
226
179
  </div>
227
-
228
180
 
229
181
  <div class="method-description">
230
-
231
182
  <p>Returns <code>true</code> when the body of the request contains a pdf file.</p>
232
-
233
-
234
183
 
235
-
236
184
  <div class="method-source-code" id="pdf-3F-source">
237
185
  <pre><span class="ruby-comment"># File lib/fattura24/api/response.rb, line 38</span>
238
186
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pdf?</span>
239
187
  <span class="ruby-identifier">http_response</span>&amp;.<span class="ruby-identifier">content_type</span>&amp;.<span class="ruby-identifier">underscore</span> <span class="ruby-operator">==</span> <span class="ruby-string">&#39;application/pdf&#39;</span>
240
188
  <span class="ruby-keyword">end</span></pre>
241
189
  </div>
242
-
243
190
  </div>
244
191
 
245
-
246
192
 
247
-
248
193
  </div>
249
194
 
250
-
251
195
  <div id="method-i-success-3F" class="method-detail ">
252
-
253
196
  <div class="method-heading">
254
197
  <span class="method-name">success?</span><span
255
198
  class="method-args">()</span>
256
-
257
199
  <span class="method-click-advice">click to toggle source</span>
258
-
259
200
  </div>
260
-
261
201
 
262
202
  <div class="method-description">
263
-
264
203
  <p>Returns <code>true</code> when the http response is 200, <code>false</code> otherwise.</p>
265
-
266
-
267
204
 
268
-
269
205
  <div class="method-source-code" id="success-3F-source">
270
206
  <pre><span class="ruby-comment"># File lib/fattura24/api/response.rb, line 23</span>
271
207
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">success?</span>
272
208
  <span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
273
209
  <span class="ruby-keyword">end</span></pre>
274
210
  </div>
275
-
276
211
  </div>
277
212
 
278
-
279
213
 
280
-
281
214
  </div>
282
215
 
283
-
284
216
  <div id="method-i-to_h" class="method-detail ">
285
-
286
217
  <div class="method-heading">
287
218
  <span class="method-name">to_h</span><span
288
219
  class="method-args">()</span>
289
-
290
220
  <span class="method-click-advice">click to toggle source</span>
291
-
292
221
  </div>
293
-
294
222
 
295
223
  <div class="method-description">
296
-
297
224
  <p>Returns an hash representation of the xml body of the response. Raises <a href="../NotSerializable.html">NotSerializable</a> in case of a binary (pdf file) content.</p>
298
-
299
-
300
225
 
301
-
302
226
  <div class="method-source-code" id="to_h-source">
303
227
  <pre><span class="ruby-comment"># File lib/fattura24/api/response.rb, line 46</span>
304
228
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
@@ -315,57 +239,41 @@
315
239
  <span class="ruby-keyword">end</span>
316
240
  <span class="ruby-keyword">end</span></pre>
317
241
  </div>
318
-
319
242
  </div>
320
243
 
321
-
322
244
 
323
-
324
245
  </div>
325
246
 
326
-
327
247
  <div id="method-i-to_s" class="method-detail ">
328
-
329
248
  <div class="method-heading">
330
249
  <span class="method-name">to_s</span><span
331
250
  class="method-args">()</span>
332
-
333
251
  <span class="method-click-advice">click to toggle source</span>
334
-
335
252
  </div>
336
-
337
253
 
338
254
  <div class="method-description">
339
-
340
255
  <p>Returns the <code>String</code> body of this response. This can be both the original xml on most of the calls or the content of the pdf file when get_file is called.</p>
341
-
342
-
343
256
 
344
-
345
257
  <div class="method-source-code" id="to_s-source">
346
258
  <pre><span class="ruby-comment"># File lib/fattura24/api/response.rb, line 65</span>
347
259
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
348
260
  <span class="ruby-identifier">http_response</span>&amp;.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_s</span>
349
261
  <span class="ruby-keyword">end</span></pre>
350
262
  </div>
351
-
352
263
  </div>
353
264
 
354
-
355
265
 
356
-
357
266
  </div>
358
267
 
359
-
360
268
  </section>
361
-
269
+
362
270
  </section>
363
271
  </main>
364
272
 
365
273
 
366
274
  <footer id="validator-badges" role="contentinfo">
367
275
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
368
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
276
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
369
277
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
370
278
  </footer>
371
279
 
@@ -21,7 +21,6 @@
21
21
  <link href="../css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
24
  <body id="top" role="document" class="class">
26
25
  <nav role="navigation">
27
26
  <div id="project-navigation">
@@ -58,24 +57,22 @@
58
57
 
59
58
  <div id="class-metadata">
60
59
 
61
- <div id="parent-class-section" class="nav-section">
60
+
61
+ <div id="parent-class-section" class="nav-section">
62
62
  <h3>Parent</h3>
63
63
 
64
-
65
64
  <p class="link">Object
66
-
67
65
  </div>
68
66
 
69
67
 
70
68
 
71
- <!-- Method Quickref -->
69
+
70
+ <!-- Method Quickref -->
72
71
  <div id="method-list-section" class="nav-section">
73
72
  <h3>Methods</h3>
74
73
 
75
74
  <ul class="link-list" role="directory">
76
-
77
75
  <li ><a href="#method-c-new">::new</a>
78
-
79
76
  </ul>
80
77
  </div>
81
78
 
@@ -91,21 +88,15 @@
91
88
 
92
89
  </section>
93
90
 
94
-
95
91
  <section id="5Buntitled-5D" class="documentation-section">
96
-
97
92
 
98
-
99
93
 
100
-
101
94
 
102
-
103
95
  <section class="attribute-method-details" class="method-section">
104
96
  <header>
105
97
  <h3>Attributes</h3>
106
98
  </header>
107
99
 
108
-
109
100
  <div id="attribute-i-api_key" class="method-detail">
110
101
  <div class="method-heading attribute-method-heading">
111
102
  <span class="method-name">api_key</span><span
@@ -113,64 +104,47 @@
113
104
  </div>
114
105
 
115
106
  <div class="method-description">
116
-
117
107
  <p>Set this attribute to your secret api key to interact with the api</p>
118
-
119
108
  </div>
120
109
  </div>
121
-
122
110
  </section>
123
-
124
111
 
125
-
112
+
126
113
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
127
114
  <header>
128
115
  <h3>Public Class Methods</h3>
129
116
  </header>
130
117
 
131
-
132
118
  <div id="method-c-new" class="method-detail ">
133
-
134
119
  <div class="method-heading">
135
120
  <span class="method-name">new</span><span
136
121
  class="method-args">()</span>
137
-
138
122
  <span class="method-click-advice">click to toggle source</span>
139
-
140
123
  </div>
141
-
142
124
 
143
125
  <div class="method-description">
144
126
 
145
-
146
-
147
-
148
127
 
149
-
150
128
  <div class="method-source-code" id="new-source">
151
129
  <pre><span class="ruby-comment"># File lib/fattura24/configuration.rb, line 10</span>
152
130
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
153
131
  <span class="ruby-ivar">@api_key</span> = <span class="ruby-keyword">nil</span>
154
132
  <span class="ruby-keyword">end</span></pre>
155
133
  </div>
156
-
157
134
  </div>
158
135
 
159
-
160
136
 
161
-
162
137
  </div>
163
138
 
164
-
165
139
  </section>
166
-
140
+
167
141
  </section>
168
142
  </main>
169
143
 
170
144
 
171
145
  <footer id="validator-badges" role="contentinfo">
172
146
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
173
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
147
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
174
148
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
175
149
  </footer>
176
150
 
@@ -21,7 +21,6 @@
21
21
  <link href="../css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
24
  <body id="top" role="document" class="module">
26
25
  <nav role="navigation">
27
26
  <div id="project-navigation">
@@ -76,58 +75,36 @@
76
75
 
77
76
  </section>
78
77
 
79
-
80
78
  <section id="5Buntitled-5D" class="documentation-section">
81
-
82
79
 
83
-
84
80
 
85
-
86
81
  <section class="constants-list">
87
82
  <header>
88
83
  <h3>Constants</h3>
89
84
  </header>
90
85
  <dl>
91
-
92
86
  <dt id="CLIENT_ORDER">CLIENT_ORDER
93
-
94
87
  <dd>
95
-
96
-
97
88
  <dt id="CREDIT_NOTE">CREDIT_NOTE
98
-
99
89
  <dd>
100
-
101
-
102
90
  <dt id="ELECTRONIC_INVOICE">ELECTRONIC_INVOICE
103
-
104
91
  <dd>
105
-
106
-
107
92
  <dt id="INVOICE">INVOICE
108
-
109
93
  <dd>
110
-
111
-
112
94
  <dt id="RECEIPT">RECEIPT
113
-
114
95
  <dd>
115
-
116
-
117
96
  </dl>
118
97
  </section>
119
-
120
98
 
121
-
122
99
 
123
-
100
+
124
101
  </section>
125
102
  </main>
126
103
 
127
104
 
128
105
  <footer id="validator-badges" role="contentinfo">
129
106
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
130
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
107
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
131
108
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
132
109
  </footer>
133
110