airtable2 0.2.1 → 0.2.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,451 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Class: Airtable::Resource
8
-
9
- &mdash; Documentation by YARD 0.9.37
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
-
17
- <script type="text/javascript">
18
- pathId = "Airtable::Resource";
19
- relpath = '../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../_index.html">Index (R)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../Airtable.html" title="Airtable (module)">Airtable</a></span></span>
41
- &raquo;
42
- <span class="title">Resource</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Class: Airtable::Resource
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">Airtable::Resource</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
- <dl>
91
- <dt>Includes:</dt>
92
- <dd>HTTParty</dd>
93
- </dl>
94
-
95
-
96
-
97
-
98
-
99
-
100
- <dl>
101
- <dt>Defined in:</dt>
102
- <dd>lib/airtable/resource.rb</dd>
103
- </dl>
104
-
105
- </div>
106
-
107
- <h2>Overview</h2><div class="docstring">
108
- <div class="discussion">
109
-
110
- <p>Base class for authorized resources sending network requests</p>
111
-
112
-
113
- </div>
114
- </div>
115
- <div class="tags">
116
-
117
-
118
- </div><div id="subclasses">
119
- <h2>Direct Known Subclasses</h2>
120
- <p class="children"><span class='object_link'><a href="Base.html" title="Airtable::Base (class)">Base</a></span>, <span class='object_link'><a href="Client.html" title="Airtable::Client (class)">Client</a></span>, <span class='object_link'><a href="Record.html" title="Airtable::Record (class)">Record</a></span>, <span class='object_link'><a href="Table.html" title="Airtable::Table (class)">Table</a></span></p>
121
- </div>
122
-
123
-
124
-
125
-
126
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
127
- <ul class="summary">
128
-
129
- <li class="public ">
130
- <span class="summary_signature">
131
-
132
- <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
133
-
134
-
135
-
136
- </span>
137
-
138
-
139
-
140
-
141
- <span class="note title readonly">readonly</span>
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- <span class="summary_desc"><div class='inline'>
152
- <p>debug_output $stdout.</p>
153
- </div></span>
154
-
155
- </li>
156
-
157
-
158
- <li class="public ">
159
- <span class="summary_signature">
160
-
161
- <a href="#token-instance_method" title="#token (instance method)">#<strong>token</strong> &#x21d2; Object </a>
162
-
163
-
164
-
165
- </span>
166
-
167
-
168
-
169
-
170
- <span class="note title readonly">readonly</span>
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
- <span class="summary_desc"><div class='inline'>
181
- <p>debug_output $stdout.</p>
182
- </div></span>
183
-
184
- </li>
185
-
186
-
187
- </ul>
188
-
189
-
190
-
191
-
192
-
193
- <h2>
194
- Instance Method Summary
195
- <small><a href="#" class="summary_toggle">collapse</a></small>
196
- </h2>
197
-
198
- <ul class="summary">
199
-
200
- <li class="public ">
201
- <span class="summary_signature">
202
-
203
- <a href="#check_and_raise_error-instance_method" title="#check_and_raise_error (instance method)">#<strong>check_and_raise_error</strong>(response) &#x21d2; Object </a>
204
-
205
-
206
-
207
- </span>
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
- <span class="summary_desc"><div class='inline'>
218
- <p>If API response is an error, raises an Airtable::Error with the error message.</p>
219
- </div></span>
220
-
221
- </li>
222
-
223
-
224
- <li class="public ">
225
- <span class="summary_signature">
226
-
227
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(token) &#x21d2; Resource </a>
228
-
229
-
230
-
231
- </span>
232
-
233
-
234
- <span class="note title constructor">constructor</span>
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
- <span class="summary_desc"><div class='inline'>
244
- <p>A new instance of Resource.</p>
245
- </div></span>
246
-
247
- </li>
248
-
249
-
250
- </ul>
251
-
252
-
253
-
254
- <div id="constructor_details" class="method_details_list">
255
- <h2>Constructor Details</h2>
256
-
257
- <div class="method_details first">
258
- <h3 class="signature first" id="initialize-instance_method">
259
-
260
- #<strong>initialize</strong>(token) &#x21d2; <tt><span class='object_link'><a href="" title="Airtable::Resource (class)">Resource</a></span></tt>
261
-
262
-
263
-
264
-
265
-
266
- </h3><div class="docstring">
267
- <div class="discussion">
268
-
269
- <p>Returns a new instance of Resource.</p>
270
-
271
-
272
- </div>
273
- </div>
274
- <div class="tags">
275
-
276
-
277
- </div><table class="source_code">
278
- <tr>
279
- <td>
280
- <pre class="lines">
281
-
282
-
283
- 11
284
- 12
285
- 13
286
- 14</pre>
287
- </td>
288
- <td>
289
- <pre class="code"><span class="info file"># File 'lib/airtable/resource.rb', line 11</span>
290
-
291
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span>
292
- <span class='ivar'>@token</span> <span class='op'>=</span> <span class='id identifier rubyid_token'>token</span>
293
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Authorization</span><span class='label_end'>&#39;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Bearer </span><span class='embexpr_beg'>#{</span><span class='ivar'>@token</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='label_end'>&#39;:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
294
- <span class='kw'>end</span></pre>
295
- </td>
296
- </tr>
297
- </table>
298
- </div>
299
-
300
- </div>
301
-
302
- <div id="instance_attr_details" class="attr_details">
303
- <h2>Instance Attribute Details</h2>
304
-
305
-
306
- <span id=""></span>
307
- <div class="method_details first">
308
- <h3 class="signature first" id="id-instance_method">
309
-
310
- #<strong>id</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
311
-
312
-
313
-
314
-
315
-
316
- </h3><div class="docstring">
317
- <div class="discussion">
318
-
319
- <p>debug_output $stdout</p>
320
-
321
-
322
- </div>
323
- </div>
324
- <div class="tags">
325
-
326
-
327
- </div><table class="source_code">
328
- <tr>
329
- <td>
330
- <pre class="lines">
331
-
332
-
333
- 9
334
- 10
335
- 11</pre>
336
- </td>
337
- <td>
338
- <pre class="code"><span class="info file"># File 'lib/airtable/resource.rb', line 9</span>
339
-
340
- <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
341
- <span class='ivar'>@id</span>
342
- <span class='kw'>end</span></pre>
343
- </td>
344
- </tr>
345
- </table>
346
- </div>
347
-
348
-
349
- <span id=""></span>
350
- <div class="method_details ">
351
- <h3 class="signature " id="token-instance_method">
352
-
353
- #<strong>token</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
354
-
355
-
356
-
357
-
358
-
359
- </h3><div class="docstring">
360
- <div class="discussion">
361
-
362
- <p>debug_output $stdout</p>
363
-
364
-
365
- </div>
366
- </div>
367
- <div class="tags">
368
-
369
-
370
- </div><table class="source_code">
371
- <tr>
372
- <td>
373
- <pre class="lines">
374
-
375
-
376
- 9
377
- 10
378
- 11</pre>
379
- </td>
380
- <td>
381
- <pre class="code"><span class="info file"># File 'lib/airtable/resource.rb', line 9</span>
382
-
383
- <span class='kw'>def</span> <span class='id identifier rubyid_token'>token</span>
384
- <span class='ivar'>@token</span>
385
- <span class='kw'>end</span></pre>
386
- </td>
387
- </tr>
388
- </table>
389
- </div>
390
-
391
- </div>
392
-
393
-
394
- <div id="instance_method_details" class="method_details_list">
395
- <h2>Instance Method Details</h2>
396
-
397
-
398
- <div class="method_details first">
399
- <h3 class="signature first" id="check_and_raise_error-instance_method">
400
-
401
- #<strong>check_and_raise_error</strong>(response) &#x21d2; <tt>Object</tt>
402
-
403
-
404
-
405
-
406
-
407
- </h3><div class="docstring">
408
- <div class="discussion">
409
-
410
- <p>If API response is an error, raises an Airtable::Error with the error message</p>
411
-
412
-
413
- </div>
414
- </div>
415
- <div class="tags">
416
-
417
-
418
- </div><table class="source_code">
419
- <tr>
420
- <td>
421
- <pre class="lines">
422
-
423
-
424
- 17
425
- 18
426
- 19</pre>
427
- </td>
428
- <td>
429
- <pre class="code"><span class="info file"># File 'lib/airtable/resource.rb', line 17</span>
430
-
431
- <span class='kw'>def</span> <span class='id identifier rubyid_check_and_raise_error'>check_and_raise_error</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
432
- <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Error.html" title="Airtable::Error (class)">Error</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>false</span>
433
- <span class='kw'>end</span></pre>
434
- </td>
435
- </tr>
436
- </table>
437
- </div>
438
-
439
- </div>
440
-
441
- </div>
442
-
443
- <div id="footer">
444
- Generated on Fri Oct 25 21:49:54 2024 by
445
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
446
- 0.9.37 (ruby-3.3.5).
447
- </div>
448
-
449
- </div>
450
- </body>
451
- </html>