airtable2 0.2.0 → 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +5 -0
- data/README.md +8 -2
- data/airtable.gemspec +1 -0
- data/docs/Airtable/Base.html +575 -0
- data/docs/Airtable/Client.html +506 -0
- data/docs/Airtable/Error.html +375 -0
- data/docs/Airtable/Record.html +327 -0
- data/docs/Airtable/Resource.html +451 -0
- data/docs/Airtable/Table.html +907 -0
- data/docs/Airtable.html +142 -0
- data/docs/_index.html +189 -0
- data/docs/class_list.html +54 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +503 -0
- data/docs/file.README.html +169 -0
- data/docs/file_list.html +59 -0
- data/docs/frames.html +22 -0
- data/docs/index.html +169 -0
- data/docs/js/app.js +344 -0
- data/docs/js/full_list.js +242 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +270 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/airtable/base.rb +11 -0
- data/lib/airtable/client.rb +32 -1
- data/lib/airtable/resource.rb +1 -0
- data/lib/airtable/table.rb +16 -1
- data/lib/airtable/version.rb +1 -1
- metadata +37 -1
@@ -0,0 +1,907 @@
|
|
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::Table
|
8
|
+
|
9
|
+
— 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::Table";
|
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 (T)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../Airtable.html" title="Airtable (module)">Airtable</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Table</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::Table
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
72
|
+
<span class="inheritName"><span class='object_link'><a href="Resource.html" title="Airtable::Resource (class)">Resource</a></span></span>
|
73
|
+
|
74
|
+
<ul class="fullTree">
|
75
|
+
<li>Object</li>
|
76
|
+
|
77
|
+
<li class="next"><span class='object_link'><a href="Resource.html" title="Airtable::Resource (class)">Resource</a></span></li>
|
78
|
+
|
79
|
+
<li class="next">Airtable::Table</li>
|
80
|
+
|
81
|
+
</ul>
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
83
|
+
|
84
|
+
</dd>
|
85
|
+
</dl>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
<dl>
|
98
|
+
<dt>Defined in:</dt>
|
99
|
+
<dd>lib/airtable/table.rb</dd>
|
100
|
+
</dl>
|
101
|
+
|
102
|
+
</div>
|
103
|
+
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
105
|
+
<div class="discussion">
|
106
|
+
|
107
|
+
<p>Object corresponding to an Airtable Table</p>
|
108
|
+
|
109
|
+
|
110
|
+
</div>
|
111
|
+
</div>
|
112
|
+
<div class="tags">
|
113
|
+
|
114
|
+
|
115
|
+
</div>
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
120
|
+
<ul class="summary">
|
121
|
+
|
122
|
+
<li class="public ">
|
123
|
+
<span class="summary_signature">
|
124
|
+
|
125
|
+
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ Object </a>
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
</span>
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
<span class="note title readonly">readonly</span>
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
<span class="summary_desc"><div class='inline'>
|
145
|
+
<p>Returns the value of attribute name.</p>
|
146
|
+
</div></span>
|
147
|
+
|
148
|
+
</li>
|
149
|
+
|
150
|
+
|
151
|
+
</ul>
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="Airtable::Resource (class)">Resource</a></span></h3>
|
158
|
+
<p class="inherited"><span class='object_link'><a href="Resource.html#id-instance_method" title="Airtable::Resource#id (method)">#id</a></span>, <span class='object_link'><a href="Resource.html#token-instance_method" title="Airtable::Resource#token (method)">#token</a></span></p>
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
<h2>
|
163
|
+
Instance Method Summary
|
164
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
165
|
+
</h2>
|
166
|
+
|
167
|
+
<ul class="summary">
|
168
|
+
|
169
|
+
<li class="public ">
|
170
|
+
<span class="summary_signature">
|
171
|
+
|
172
|
+
<a href="#add_records-instance_method" title="#add_records (instance method)">#<strong>add_records</strong>(records) ⇒ Array<Airtable::Record> </a>
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
</span>
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
187
|
+
|
188
|
+
</li>
|
189
|
+
|
190
|
+
|
191
|
+
<li class="public ">
|
192
|
+
<span class="summary_signature">
|
193
|
+
|
194
|
+
<a href="#delete_records-instance_method" title="#delete_records (instance method)">#<strong>delete_records</strong>(record_ids) ⇒ Array </a>
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
</span>
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
<span class="summary_desc"><div class='inline'>
|
209
|
+
<p>Deleted record ids.</p>
|
210
|
+
</div></span>
|
211
|
+
|
212
|
+
</li>
|
213
|
+
|
214
|
+
|
215
|
+
<li class="public ">
|
216
|
+
<span class="summary_signature">
|
217
|
+
|
218
|
+
<a href="#dump-instance_method" title="#dump (instance method)">#<strong>dump</strong> ⇒ Object </a>
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
</span>
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
<span class="summary_desc"><div class='inline'>
|
233
|
+
<p>Deletes all table’s records.</p>
|
234
|
+
</div></span>
|
235
|
+
|
236
|
+
</li>
|
237
|
+
|
238
|
+
|
239
|
+
<li class="public ">
|
240
|
+
<span class="summary_signature">
|
241
|
+
|
242
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(token, base_id, api_response) ⇒ Table </a>
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
</span>
|
247
|
+
|
248
|
+
|
249
|
+
<span class="note title constructor">constructor</span>
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
<span class="summary_desc"><div class='inline'>
|
259
|
+
<p>A new instance of Table.</p>
|
260
|
+
</div></span>
|
261
|
+
|
262
|
+
</li>
|
263
|
+
|
264
|
+
|
265
|
+
<li class="public ">
|
266
|
+
<span class="summary_signature">
|
267
|
+
|
268
|
+
<a href="#record-instance_method" title="#record (instance method)">#<strong>record</strong>(record_id) ⇒ Airtable::Table </a>
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
</span>
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
<span class="summary_desc"><div class='inline'>
|
283
|
+
<p>Instantiate record in table.</p>
|
284
|
+
</div></span>
|
285
|
+
|
286
|
+
</li>
|
287
|
+
|
288
|
+
|
289
|
+
<li class="public ">
|
290
|
+
<span class="summary_signature">
|
291
|
+
|
292
|
+
<a href="#records-instance_method" title="#records (instance method)">#<strong>records</strong> ⇒ Array<Airtable::Record> </a>
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
</span>
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
|
305
|
+
|
306
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
307
|
+
|
308
|
+
</li>
|
309
|
+
|
310
|
+
|
311
|
+
<li class="protected ">
|
312
|
+
<span class="summary_signature">
|
313
|
+
|
314
|
+
<a href="#table_url-instance_method" title="#table_url (instance method)">#<strong>table_url</strong> ⇒ Object </a>
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
</span>
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
<span class="note title protected">protected</span>
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
329
|
+
|
330
|
+
</li>
|
331
|
+
|
332
|
+
|
333
|
+
<li class="public ">
|
334
|
+
<span class="summary_signature">
|
335
|
+
|
336
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(table_data) ⇒ Airtable::Table </a>
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
</span>
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
351
|
+
|
352
|
+
</li>
|
353
|
+
|
354
|
+
|
355
|
+
</ul>
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="Airtable::Resource (class)">Resource</a></span></h3>
|
368
|
+
<p class="inherited"><span class='object_link'><a href="Resource.html#check_and_raise_error-instance_method" title="Airtable::Resource#check_and_raise_error (method)">#check_and_raise_error</a></span></p>
|
369
|
+
|
370
|
+
<div id="constructor_details" class="method_details_list">
|
371
|
+
<h2>Constructor Details</h2>
|
372
|
+
|
373
|
+
<div class="method_details first">
|
374
|
+
<h3 class="signature first" id="initialize-instance_method">
|
375
|
+
|
376
|
+
#<strong>initialize</strong>(token, base_id, api_response) ⇒ <tt><span class='object_link'><a href="" title="Airtable::Table (class)">Table</a></span></tt>
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
</h3><div class="docstring">
|
383
|
+
<div class="discussion">
|
384
|
+
|
385
|
+
<p>Returns a new instance of Table.</p>
|
386
|
+
|
387
|
+
|
388
|
+
</div>
|
389
|
+
</div>
|
390
|
+
<div class="tags">
|
391
|
+
|
392
|
+
|
393
|
+
</div><table class="source_code">
|
394
|
+
<tr>
|
395
|
+
<td>
|
396
|
+
<pre class="lines">
|
397
|
+
|
398
|
+
|
399
|
+
7
|
400
|
+
8
|
401
|
+
9
|
402
|
+
10
|
403
|
+
11
|
404
|
+
12
|
405
|
+
13
|
406
|
+
14</pre>
|
407
|
+
</td>
|
408
|
+
<td>
|
409
|
+
<pre class="code"><span class="info file"># File 'lib/airtable/table.rb', line 7</span>
|
410
|
+
|
411
|
+
<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='comma'>,</span> <span class='id identifier rubyid_base_id'>base_id</span><span class='comma'>,</span> <span class='id identifier rubyid_api_response'>api_response</span><span class='rparen'>)</span>
|
412
|
+
<span class='ivar'>@token</span> <span class='op'>=</span> <span class='id identifier rubyid_token'>token</span>
|
413
|
+
<span class='ivar'>@base_id</span> <span class='op'>=</span> <span class='id identifier rubyid_base_id'>base_id</span>
|
414
|
+
<span class='id identifier rubyid_api_response'>api_response</span><span class='period'>.</span><span class='id identifier rubyid_deep_symbolize_keys'>deep_symbolize_keys</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
415
|
+
<span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:"@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
416
|
+
<span class='kw'>end</span>
|
417
|
+
<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'>'</span><span class='tstring_content'>Authorization</span><span class='label_end'>':</span> <span class='tstring'><span class='tstring_beg'>"</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'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='label_end'>':</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
418
|
+
<span class='kw'>end</span></pre>
|
419
|
+
</td>
|
420
|
+
</tr>
|
421
|
+
</table>
|
422
|
+
</div>
|
423
|
+
|
424
|
+
</div>
|
425
|
+
|
426
|
+
<div id="instance_attr_details" class="attr_details">
|
427
|
+
<h2>Instance Attribute Details</h2>
|
428
|
+
|
429
|
+
|
430
|
+
<span id=""></span>
|
431
|
+
<div class="method_details first">
|
432
|
+
<h3 class="signature first" id="name-instance_method">
|
433
|
+
|
434
|
+
#<strong>name</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
</h3><div class="docstring">
|
441
|
+
<div class="discussion">
|
442
|
+
|
443
|
+
<p>Returns the value of attribute name.</p>
|
444
|
+
|
445
|
+
|
446
|
+
</div>
|
447
|
+
</div>
|
448
|
+
<div class="tags">
|
449
|
+
|
450
|
+
|
451
|
+
</div><table class="source_code">
|
452
|
+
<tr>
|
453
|
+
<td>
|
454
|
+
<pre class="lines">
|
455
|
+
|
456
|
+
|
457
|
+
5
|
458
|
+
6
|
459
|
+
7</pre>
|
460
|
+
</td>
|
461
|
+
<td>
|
462
|
+
<pre class="code"><span class="info file"># File 'lib/airtable/table.rb', line 5</span>
|
463
|
+
|
464
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
|
465
|
+
<span class='ivar'>@name</span>
|
466
|
+
<span class='kw'>end</span></pre>
|
467
|
+
</td>
|
468
|
+
</tr>
|
469
|
+
</table>
|
470
|
+
</div>
|
471
|
+
|
472
|
+
</div>
|
473
|
+
|
474
|
+
|
475
|
+
<div id="instance_method_details" class="method_details_list">
|
476
|
+
<h2>Instance Method Details</h2>
|
477
|
+
|
478
|
+
|
479
|
+
<div class="method_details first">
|
480
|
+
<h3 class="signature first" id="add_records-instance_method">
|
481
|
+
|
482
|
+
#<strong>add_records</strong>(records) ⇒ <tt>Array<<span class='object_link'><a href="Record.html" title="Airtable::Record (class)">Airtable::Record</a></span>></tt>
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
</h3><div class="docstring">
|
489
|
+
<div class="discussion">
|
490
|
+
|
491
|
+
<div class="note notetag">
|
492
|
+
<strong>Note:</strong>
|
493
|
+
<div class='inline'>
|
494
|
+
<p>API maximum of 10 records at a time</p>
|
495
|
+
</div>
|
496
|
+
</div>
|
497
|
+
|
498
|
+
|
499
|
+
|
500
|
+
</div>
|
501
|
+
</div>
|
502
|
+
<div class="tags">
|
503
|
+
|
504
|
+
<p class="tag_title">Returns:</p>
|
505
|
+
<ul class="return">
|
506
|
+
|
507
|
+
<li>
|
508
|
+
|
509
|
+
|
510
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Record.html" title="Airtable::Record (class)">Airtable::Record</a></span>></tt>)</span>
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
</li>
|
515
|
+
|
516
|
+
</ul>
|
517
|
+
|
518
|
+
<p class="tag_title">See Also:</p>
|
519
|
+
<ul class="see">
|
520
|
+
|
521
|
+
<li><a href="https://airtable.com/developers/web/api/create-records" target="_parent" title="https://airtable.com/developers/web/api/create-records">https://airtable.com/developers/web/api/create-records</a></li>
|
522
|
+
|
523
|
+
</ul>
|
524
|
+
|
525
|
+
</div><table class="source_code">
|
526
|
+
<tr>
|
527
|
+
<td>
|
528
|
+
<pre class="lines">
|
529
|
+
|
530
|
+
|
531
|
+
46
|
532
|
+
47
|
533
|
+
48
|
534
|
+
49
|
535
|
+
50
|
536
|
+
51
|
537
|
+
52
|
538
|
+
53</pre>
|
539
|
+
</td>
|
540
|
+
<td>
|
541
|
+
<pre class="code"><span class="info file"># File 'lib/airtable/table.rb', line 46</span>
|
542
|
+
|
543
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_records'>add_records</span><span class='lparen'>(</span><span class='id identifier rubyid_records'>records</span><span class='rparen'>)</span>
|
544
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <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_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_table_url'>table_url</span><span class='comma'>,</span>
|
545
|
+
<span class='label'>body:</span> <span class='lbrace'>{</span> <span class='label'>records:</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_records'>records</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_fields'>fields</span><span class='op'>|</span> <span class='lbrace'>{</span> <span class='label'>fields:</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parsed_response'>parsed_response</span>
|
546
|
+
|
547
|
+
<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>
|
548
|
+
|
549
|
+
<span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>records</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='const'><span class='object_link'><a href="../Airtable.html" title="Airtable (module)">Airtable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Record.html" title="Airtable::Record (class)">Record</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Record.html#initialize-instance_method" title="Airtable::Record#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='ivar'>@token</span><span class='comma'>,</span> <span class='ivar'>@base_id</span><span class='comma'>,</span> <span class='ivar'>@id</span><span class='comma'>,</span> <span class='id identifier rubyid__1'>_1</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
550
|
+
<span class='kw'>end</span></pre>
|
551
|
+
</td>
|
552
|
+
</tr>
|
553
|
+
</table>
|
554
|
+
</div>
|
555
|
+
|
556
|
+
<div class="method_details ">
|
557
|
+
<h3 class="signature " id="delete_records-instance_method">
|
558
|
+
|
559
|
+
#<strong>delete_records</strong>(record_ids) ⇒ <tt>Array</tt>
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
|
564
|
+
|
565
|
+
</h3><div class="docstring">
|
566
|
+
<div class="discussion">
|
567
|
+
|
568
|
+
<p>Returns Deleted record ids.</p>
|
569
|
+
|
570
|
+
|
571
|
+
</div>
|
572
|
+
</div>
|
573
|
+
<div class="tags">
|
574
|
+
|
575
|
+
<p class="tag_title">Returns:</p>
|
576
|
+
<ul class="return">
|
577
|
+
|
578
|
+
<li>
|
579
|
+
|
580
|
+
|
581
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
582
|
+
|
583
|
+
|
584
|
+
|
585
|
+
—
|
586
|
+
<div class='inline'>
|
587
|
+
<p>Deleted record ids</p>
|
588
|
+
</div>
|
589
|
+
|
590
|
+
</li>
|
591
|
+
|
592
|
+
</ul>
|
593
|
+
|
594
|
+
<p class="tag_title">See Also:</p>
|
595
|
+
<ul class="see">
|
596
|
+
|
597
|
+
<li><a href="https://airtable.com/developers/web/api/delete-multiple-records" target="_parent" title="https://airtable.com/developers/web/api/delete-multiple-records">https://airtable.com/developers/web/api/delete-multiple-records</a></li>
|
598
|
+
|
599
|
+
</ul>
|
600
|
+
|
601
|
+
</div><table class="source_code">
|
602
|
+
<tr>
|
603
|
+
<td>
|
604
|
+
<pre class="lines">
|
605
|
+
|
606
|
+
|
607
|
+
57
|
608
|
+
58
|
609
|
+
59
|
610
|
+
60
|
611
|
+
61
|
612
|
+
62
|
613
|
+
63
|
614
|
+
64</pre>
|
615
|
+
</td>
|
616
|
+
<td>
|
617
|
+
<pre class="code"><span class="info file"># File 'lib/airtable/table.rb', line 57</span>
|
618
|
+
|
619
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_records'>delete_records</span><span class='lparen'>(</span><span class='id identifier rubyid_record_ids'>record_ids</span><span class='rparen'>)</span>
|
620
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_record_ids'>record_ids</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>records[]=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid__1'>_1</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>&</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
621
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <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_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_table_url'>table_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>?</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parsed_response'>parsed_response</span>
|
622
|
+
|
623
|
+
<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>
|
624
|
+
|
625
|
+
<span class='id identifier rubyid_record_ids'>record_ids</span>
|
626
|
+
<span class='kw'>end</span></pre>
|
627
|
+
</td>
|
628
|
+
</tr>
|
629
|
+
</table>
|
630
|
+
</div>
|
631
|
+
|
632
|
+
<div class="method_details ">
|
633
|
+
<h3 class="signature " id="dump-instance_method">
|
634
|
+
|
635
|
+
#<strong>dump</strong> ⇒ <tt>Object</tt>
|
636
|
+
|
637
|
+
|
638
|
+
|
639
|
+
|
640
|
+
|
641
|
+
</h3><div class="docstring">
|
642
|
+
<div class="discussion">
|
643
|
+
|
644
|
+
<p>Deletes all table’s records</p>
|
645
|
+
|
646
|
+
|
647
|
+
</div>
|
648
|
+
</div>
|
649
|
+
<div class="tags">
|
650
|
+
|
651
|
+
|
652
|
+
</div><table class="source_code">
|
653
|
+
<tr>
|
654
|
+
<td>
|
655
|
+
<pre class="lines">
|
656
|
+
|
657
|
+
|
658
|
+
67
|
659
|
+
68
|
660
|
+
69
|
661
|
+
70
|
662
|
+
71
|
663
|
+
72</pre>
|
664
|
+
</td>
|
665
|
+
<td>
|
666
|
+
<pre class="code"><span class="info file"># File 'lib/airtable/table.rb', line 67</span>
|
667
|
+
|
668
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_dump'>dump</span>
|
669
|
+
<span class='id identifier rubyid_records'>records</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each_slice'>each_slice</span><span class='lparen'>(</span><span class='int'>10</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_record_id_set'>record_id_set</span><span class='op'>|</span>
|
670
|
+
<span class='id identifier rubyid_delete_records'>delete_records</span><span class='lparen'>(</span><span class='id identifier rubyid_record_id_set'>record_id_set</span><span class='rparen'>)</span>
|
671
|
+
<span class='id identifier rubyid_sleep'>sleep</span><span class='lparen'>(</span><span class='float'>0.2</span><span class='rparen'>)</span>
|
672
|
+
<span class='kw'>end</span>
|
673
|
+
<span class='kw'>end</span></pre>
|
674
|
+
</td>
|
675
|
+
</tr>
|
676
|
+
</table>
|
677
|
+
</div>
|
678
|
+
|
679
|
+
<div class="method_details ">
|
680
|
+
<h3 class="signature " id="record-instance_method">
|
681
|
+
|
682
|
+
#<strong>record</strong>(record_id) ⇒ <tt><span class='object_link'><a href="" title="Airtable::Table (class)">Airtable::Table</a></span></tt>
|
683
|
+
|
684
|
+
|
685
|
+
|
686
|
+
|
687
|
+
|
688
|
+
</h3><div class="docstring">
|
689
|
+
<div class="discussion">
|
690
|
+
|
691
|
+
<p>Instantiate record in table</p>
|
692
|
+
|
693
|
+
|
694
|
+
</div>
|
695
|
+
</div>
|
696
|
+
<div class="tags">
|
697
|
+
|
698
|
+
<p class="tag_title">Returns:</p>
|
699
|
+
<ul class="return">
|
700
|
+
|
701
|
+
<li>
|
702
|
+
|
703
|
+
|
704
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Airtable::Table (class)">Airtable::Table</a></span></tt>)</span>
|
705
|
+
|
706
|
+
|
707
|
+
|
708
|
+
</li>
|
709
|
+
|
710
|
+
</ul>
|
711
|
+
|
712
|
+
</div><table class="source_code">
|
713
|
+
<tr>
|
714
|
+
<td>
|
715
|
+
<pre class="lines">
|
716
|
+
|
717
|
+
|
718
|
+
28
|
719
|
+
29
|
720
|
+
30</pre>
|
721
|
+
</td>
|
722
|
+
<td>
|
723
|
+
<pre class="code"><span class="info file"># File 'lib/airtable/table.rb', line 28</span>
|
724
|
+
|
725
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_record'>record</span><span class='lparen'>(</span><span class='id identifier rubyid_record_id'>record_id</span><span class='rparen'>)</span>
|
726
|
+
<span class='const'><span class='object_link'><a href="../Airtable.html" title="Airtable (module)">Airtable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Airtable::Table (class)">Table</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Airtable::Table#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='ivar'>@token</span><span class='comma'>,</span> <span class='ivar'>@base_id</span><span class='comma'>,</span> <span class='ivar'>@id</span><span class='comma'>,</span> <span class='id identifier rubyid_record_id'>record_id</span><span class='rparen'>)</span>
|
727
|
+
<span class='kw'>end</span></pre>
|
728
|
+
</td>
|
729
|
+
</tr>
|
730
|
+
</table>
|
731
|
+
</div>
|
732
|
+
|
733
|
+
<div class="method_details ">
|
734
|
+
<h3 class="signature " id="records-instance_method">
|
735
|
+
|
736
|
+
#<strong>records</strong> ⇒ <tt>Array<<span class='object_link'><a href="Record.html" title="Airtable::Record (class)">Airtable::Record</a></span>></tt>
|
737
|
+
|
738
|
+
|
739
|
+
|
740
|
+
|
741
|
+
|
742
|
+
</h3><div class="docstring">
|
743
|
+
<div class="discussion">
|
744
|
+
|
745
|
+
|
746
|
+
</div>
|
747
|
+
</div>
|
748
|
+
<div class="tags">
|
749
|
+
|
750
|
+
<p class="tag_title">Returns:</p>
|
751
|
+
<ul class="return">
|
752
|
+
|
753
|
+
<li>
|
754
|
+
|
755
|
+
|
756
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Record.html" title="Airtable::Record (class)">Airtable::Record</a></span>></tt>)</span>
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
</li>
|
761
|
+
|
762
|
+
</ul>
|
763
|
+
|
764
|
+
<p class="tag_title">See Also:</p>
|
765
|
+
<ul class="see">
|
766
|
+
|
767
|
+
<li><a href="https://airtable.com/developers/web/api/list-records" target="_parent" title="https://airtable.com/developers/web/api/list-records">https://airtable.com/developers/web/api/list-records</a></li>
|
768
|
+
|
769
|
+
</ul>
|
770
|
+
|
771
|
+
</div><table class="source_code">
|
772
|
+
<tr>
|
773
|
+
<td>
|
774
|
+
<pre class="lines">
|
775
|
+
|
776
|
+
|
777
|
+
18
|
778
|
+
19
|
779
|
+
20
|
780
|
+
21
|
781
|
+
22
|
782
|
+
23
|
783
|
+
24</pre>
|
784
|
+
</td>
|
785
|
+
<td>
|
786
|
+
<pre class="code"><span class="info file"># File 'lib/airtable/table.rb', line 18</span>
|
787
|
+
|
788
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_records'>records</span>
|
789
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <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_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_table_url'>table_url</span><span class='rparen'>)</span>
|
790
|
+
|
791
|
+
<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>
|
792
|
+
|
793
|
+
<span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>records</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='const'><span class='object_link'><a href="../Airtable.html" title="Airtable (module)">Airtable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Record.html" title="Airtable::Record (class)">Record</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Record.html#initialize-instance_method" title="Airtable::Record#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='ivar'>@token</span><span class='comma'>,</span> <span class='ivar'>@base_id</span><span class='comma'>,</span> <span class='ivar'>@table_id</span><span class='comma'>,</span> <span class='id identifier rubyid__1'>_1</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
794
|
+
<span class='kw'>end</span></pre>
|
795
|
+
</td>
|
796
|
+
</tr>
|
797
|
+
</table>
|
798
|
+
</div>
|
799
|
+
|
800
|
+
<div class="method_details ">
|
801
|
+
<h3 class="signature " id="table_url-instance_method">
|
802
|
+
|
803
|
+
#<strong>table_url</strong> ⇒ <tt>Object</tt> <span class="extras">(protected)</span>
|
804
|
+
|
805
|
+
|
806
|
+
|
807
|
+
|
808
|
+
|
809
|
+
</h3><table class="source_code">
|
810
|
+
<tr>
|
811
|
+
<td>
|
812
|
+
<pre class="lines">
|
813
|
+
|
814
|
+
|
815
|
+
76</pre>
|
816
|
+
</td>
|
817
|
+
<td>
|
818
|
+
<pre class="code"><span class="info file"># File 'lib/airtable/table.rb', line 76</span>
|
819
|
+
|
820
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_table_url'>table_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/v0/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span></pre>
|
821
|
+
</td>
|
822
|
+
</tr>
|
823
|
+
</table>
|
824
|
+
</div>
|
825
|
+
|
826
|
+
<div class="method_details ">
|
827
|
+
<h3 class="signature " id="update-instance_method">
|
828
|
+
|
829
|
+
#<strong>update</strong>(table_data) ⇒ <tt><span class='object_link'><a href="" title="Airtable::Table (class)">Airtable::Table</a></span></tt>
|
830
|
+
|
831
|
+
|
832
|
+
|
833
|
+
|
834
|
+
|
835
|
+
</h3><div class="docstring">
|
836
|
+
<div class="discussion">
|
837
|
+
|
838
|
+
|
839
|
+
</div>
|
840
|
+
</div>
|
841
|
+
<div class="tags">
|
842
|
+
|
843
|
+
<p class="tag_title">Returns:</p>
|
844
|
+
<ul class="return">
|
845
|
+
|
846
|
+
<li>
|
847
|
+
|
848
|
+
|
849
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Airtable::Table (class)">Airtable::Table</a></span></tt>)</span>
|
850
|
+
|
851
|
+
|
852
|
+
|
853
|
+
</li>
|
854
|
+
|
855
|
+
</ul>
|
856
|
+
|
857
|
+
<p class="tag_title">See Also:</p>
|
858
|
+
<ul class="see">
|
859
|
+
|
860
|
+
<li><a href="https://airtable.com/developers/web/api/update-table" target="_parent" title="https://airtable.com/developers/web/api/update-table">https://airtable.com/developers/web/api/update-table</a></li>
|
861
|
+
|
862
|
+
</ul>
|
863
|
+
|
864
|
+
</div><table class="source_code">
|
865
|
+
<tr>
|
866
|
+
<td>
|
867
|
+
<pre class="lines">
|
868
|
+
|
869
|
+
|
870
|
+
34
|
871
|
+
35
|
872
|
+
36
|
873
|
+
37
|
874
|
+
38
|
875
|
+
39
|
876
|
+
40
|
877
|
+
41</pre>
|
878
|
+
</td>
|
879
|
+
<td>
|
880
|
+
<pre class="code"><span class="info file"># File 'lib/airtable/table.rb', line 34</span>
|
881
|
+
|
882
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_table_data'>table_data</span><span class='rparen'>)</span>
|
883
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <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_patch'>patch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/v0/meta/bases/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/tables/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
884
|
+
<span class='label'>body:</span> <span class='id identifier rubyid_table_data'>table_data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parsed_response'>parsed_response</span>
|
885
|
+
|
886
|
+
<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>
|
887
|
+
|
888
|
+
<span class='const'><span class='object_link'><a href="../Airtable.html" title="Airtable (module)">Airtable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Airtable::Table (class)">Table</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Airtable::Table#initialize (method)">new</a></span></span> <span class='ivar'>@token</span><span class='comma'>,</span> <span class='ivar'>@base_id</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span>
|
889
|
+
<span class='kw'>end</span></pre>
|
890
|
+
</td>
|
891
|
+
</tr>
|
892
|
+
</table>
|
893
|
+
</div>
|
894
|
+
|
895
|
+
</div>
|
896
|
+
|
897
|
+
</div>
|
898
|
+
|
899
|
+
<div id="footer">
|
900
|
+
Generated on Fri Oct 25 21:49:53 2024 by
|
901
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
902
|
+
0.9.37 (ruby-3.3.5).
|
903
|
+
</div>
|
904
|
+
|
905
|
+
</div>
|
906
|
+
</body>
|
907
|
+
</html>
|