attio 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. checksums.yaml +7 -0
  2. data/.codecov.yml +52 -0
  3. data/.github/CODEOWNERS +28 -0
  4. data/.github/ISSUE_TEMPLATE/bug_report.md +40 -0
  5. data/.github/ISSUE_TEMPLATE/feature_request.md +28 -0
  6. data/.github/dependabot.yml +54 -0
  7. data/.github/pull_request_template.md +40 -0
  8. data/.github/workflows/ci.yml +112 -0
  9. data/.github/workflows/dependabot-auto-merge.yml +45 -0
  10. data/.github/workflows/pr_checks.yml +145 -0
  11. data/.github/workflows/release.yml +147 -0
  12. data/.gitignore +10 -0
  13. data/.rspec +4 -0
  14. data/.rubocop.yml +133 -0
  15. data/.yardopts +18 -0
  16. data/CHANGELOG.md +34 -0
  17. data/CODE_OF_CONDUCT.md +37 -0
  18. data/CONTRIBUTING.md +280 -0
  19. data/Gemfile +17 -0
  20. data/Gemfile.lock +127 -0
  21. data/LICENSE.txt +21 -0
  22. data/README.md +292 -0
  23. data/Rakefile +57 -0
  24. data/SECURITY.md +59 -0
  25. data/attio.gemspec +34 -0
  26. data/bin/console +14 -0
  27. data/bin/setup +8 -0
  28. data/danger/Dangerfile +121 -0
  29. data/docs/.nojekyll +0 -0
  30. data/docs/Attio/AuthenticationError.html +152 -0
  31. data/docs/Attio/Client.html +1373 -0
  32. data/docs/Attio/ConnectionPool/TimeoutError.html +148 -0
  33. data/docs/Attio/ConnectionPool.html +944 -0
  34. data/docs/Attio/Error.html +152 -0
  35. data/docs/Attio/HttpClient/ConnectionError.html +152 -0
  36. data/docs/Attio/HttpClient/TimeoutError.html +152 -0
  37. data/docs/Attio/HttpClient.html +1329 -0
  38. data/docs/Attio/Logger.html +747 -0
  39. data/docs/Attio/NotFoundError.html +152 -0
  40. data/docs/Attio/RateLimitError.html +152 -0
  41. data/docs/Attio/RequestLogger.html +780 -0
  42. data/docs/Attio/Resources/Attributes.html +508 -0
  43. data/docs/Attio/Resources/Base.html +624 -0
  44. data/docs/Attio/Resources/Lists.html +1002 -0
  45. data/docs/Attio/Resources/Objects.html +415 -0
  46. data/docs/Attio/Resources/Records.html +1465 -0
  47. data/docs/Attio/Resources/Users.html +415 -0
  48. data/docs/Attio/Resources/Workspaces.html +324 -0
  49. data/docs/Attio/Resources.html +141 -0
  50. data/docs/Attio/RetryHandler.html +1023 -0
  51. data/docs/Attio/ServerError.html +152 -0
  52. data/docs/Attio/ValidationError.html +152 -0
  53. data/docs/Attio.html +397 -0
  54. data/docs/SETUP.md +117 -0
  55. data/docs/_index.html +378 -0
  56. data/docs/class_list.html +54 -0
  57. data/docs/css/common.css +1 -0
  58. data/docs/css/full_list.css +58 -0
  59. data/docs/css/style.css +503 -0
  60. data/docs/example.rb +119 -0
  61. data/docs/file.CHANGELOG.html +124 -0
  62. data/docs/file.README.html +371 -0
  63. data/docs/file_list.html +64 -0
  64. data/docs/frames.html +22 -0
  65. data/docs/index.html +371 -0
  66. data/docs/js/app.js +344 -0
  67. data/docs/js/full_list.js +242 -0
  68. data/docs/js/jquery.js +4 -0
  69. data/docs/method_list.html +750 -0
  70. data/docs/top-level-namespace.html +110 -0
  71. data/lib/attio/client.rb +118 -0
  72. data/lib/attio/connection_pool.rb +69 -0
  73. data/lib/attio/errors.rb +9 -0
  74. data/lib/attio/http_client.rb +100 -0
  75. data/lib/attio/logger.rb +110 -0
  76. data/lib/attio/resources/attributes.rb +26 -0
  77. data/lib/attio/resources/base.rb +55 -0
  78. data/lib/attio/resources/lists.rb +56 -0
  79. data/lib/attio/resources/objects.rb +20 -0
  80. data/lib/attio/resources/records.rb +158 -0
  81. data/lib/attio/resources/users.rb +20 -0
  82. data/lib/attio/resources/workspaces.rb +13 -0
  83. data/lib/attio/retry_handler.rb +70 -0
  84. data/lib/attio/version.rb +3 -0
  85. data/lib/attio.rb +60 -0
  86. data/run_tests.rb +52 -0
  87. data/test_basic.rb +51 -0
  88. data/test_typhoeus.rb +31 -0
  89. metadata +160 -0
data/docs/Attio/Resources/Records.html ADDED
@@ -0,0 +1,1465 @@
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: Attio::Resources::Records
8
+
9
+ &mdash; Attio Ruby Client Documentation
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 = "Attio::Resources::Records";
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="../../Attio.html" title="Attio (module)">Attio</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resources.html" title="Attio::Resources (module)">Resources</a></span></span>
41
+ &raquo;
42
+ <span class="title">Records</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: Attio::Resources::Records
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="Base.html" title="Attio::Resources::Base (class)">Base</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Base.html" title="Attio::Resources::Base (class)">Base</a></span></li>
78
+
79
+ <li class="next">Attio::Resources::Records</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/attio/resources/records.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+ <p>Handles all record-related API operations.</p>
107
+
108
+ <p>Records are the main data entities in Attio, representing things like
109
+ people, companies, deals, etc. This class provides methods to create,
110
+ read, update, delete, and query records.</p>
111
+
112
+
113
+ </div>
114
+ </div>
115
+ <div class="tags">
116
+
117
+ <div class="examples">
118
+ <h4 class="tag_title">Examples:</h4>
119
+
120
+
121
+ <h5 class="example_title"><div class='inline'><p>List records</p>
122
+ </div></h5>
123
+
124
+ <pre class="example code"><code><span class='id identifier rubyid_records'>records</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_records'>records</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>object:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>people</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>filters:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>John</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span></code></pre>
125
+
126
+
127
+ <h5 class="example_title"><div class='inline'><p>Create a record</p>
128
+ </div></h5>
129
+
130
+ <pre class="example code"><code><span class='id identifier rubyid_record'>record</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_records'>records</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
131
+ <span class='label'>object:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>people</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
132
+ <span class='label'>data:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Jane Doe</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>jane@example.com</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
133
+ <span class='rparen'>)</span></code></pre>
134
+
135
+ </div>
136
+
137
+ <p class="tag_title">Author:</p>
138
+ <ul class="author">
139
+
140
+ <li>
141
+
142
+
143
+
144
+
145
+
146
+ <div class='inline'><p>Ernest Sim</p>
147
+ </div>
148
+
149
+ </li>
150
+
151
+ </ul>
152
+ <p class="tag_title">Since:</p>
153
+ <ul class="since">
154
+
155
+ <li>
156
+
157
+
158
+
159
+
160
+
161
+ <div class='inline'><p>1.0.0</p>
162
+ </div>
163
+
164
+ </li>
165
+
166
+ </ul>
167
+
168
+ </div>
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <h2>
177
+ Instance Method Summary
178
+ <small><a href="#" class="summary_toggle">collapse</a></small>
179
+ </h2>
180
+
181
+ <ul class="summary">
182
+
183
+ <li class="public ">
184
+ <span class="summary_signature">
185
+
186
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(object:, data:) &#x21d2; Hash </a>
187
+
188
+
189
+
190
+ </span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'><p>Create a new record.</p>
201
+ </div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(object:, id:) &#x21d2; Hash </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <span class="summary_desc"><div class='inline'><p>Delete a record.</p>
224
+ </div></span>
225
+
226
+ </li>
227
+
228
+
229
+ <li class="public ">
230
+ <span class="summary_signature">
231
+
232
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(object:, id:) &#x21d2; Hash </a>
233
+
234
+
235
+
236
+ </span>
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+ <span class="summary_desc"><div class='inline'><p>Retrieve a specific record by ID.</p>
247
+ </div></span>
248
+
249
+ </li>
250
+
251
+
252
+ <li class="public ">
253
+ <span class="summary_signature">
254
+
255
+ <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(object:, **params) &#x21d2; Hash </a>
256
+
257
+
258
+
259
+ </span>
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+ <span class="summary_desc"><div class='inline'><p>Query and list records for a specific object type.</p>
270
+ </div></span>
271
+
272
+ </li>
273
+
274
+
275
+ <li class="public ">
276
+ <span class="summary_signature">
277
+
278
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(object:, id:, data:) &#x21d2; Hash </a>
279
+
280
+
281
+
282
+ </span>
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+ <span class="summary_desc"><div class='inline'><p>Update an existing record.</p>
293
+ </div></span>
294
+
295
+ </li>
296
+
297
+
298
+ <li class="private ">
299
+ <span class="summary_signature">
300
+
301
+ <a href="#validate_data!-instance_method" title="#validate_data! (instance method)">#<strong>validate_data!</strong>(data) &#x21d2; Object </a>
302
+
303
+
304
+
305
+ </span>
306
+
307
+
308
+
309
+ <span class="note title private">private</span>
310
+
311
+
312
+ <span class="private note title">private</span>
313
+
314
+
315
+ <span class="summary_desc"><div class='inline'><p>Validates that the data parameter is present and is a hash.</p>
316
+ </div></span>
317
+
318
+ </li>
319
+
320
+
321
+ <li class="private ">
322
+ <span class="summary_signature">
323
+
324
+ <a href="#validate_id!-instance_method" title="#validate_id! (instance method)">#<strong>validate_id!</strong>(id) &#x21d2; Object </a>
325
+
326
+
327
+
328
+ </span>
329
+
330
+
331
+
332
+ <span class="note title private">private</span>
333
+
334
+
335
+ <span class="private note title">private</span>
336
+
337
+
338
+ <span class="summary_desc"><div class='inline'><p>Validates that the ID parameter is present and not empty.</p>
339
+ </div></span>
340
+
341
+ </li>
342
+
343
+
344
+ <li class="private ">
345
+ <span class="summary_signature">
346
+
347
+ <a href="#validate_object!-instance_method" title="#validate_object! (instance method)">#<strong>validate_object!</strong>(object) &#x21d2; Object </a>
348
+
349
+
350
+
351
+ </span>
352
+
353
+
354
+
355
+ <span class="note title private">private</span>
356
+
357
+
358
+ <span class="private note title">private</span>
359
+
360
+
361
+ <span class="summary_desc"><div class='inline'><p>Validates that the object parameter is present and not empty.</p>
362
+ </div></span>
363
+
364
+ </li>
365
+
366
+
367
+ </ul>
368
+
369
+
370
+
371
+
372
+ <div id="constructor_details" class="method_details_list">
373
+ <h2>Constructor Details</h2>
374
+
375
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="Attio::Resources::Base#initialize (method)">Attio::Resources::Base</a></span></p>
376
+
377
+ </div>
378
+
379
+
380
+ <div id="instance_method_details" class="method_details_list">
381
+ <h2>Instance Method Details</h2>
382
+
383
+
384
+ <div class="method_details first">
385
+ <h3 class="signature first" id="create-instance_method">
386
+
387
+ #<strong>create</strong>(object:, data:) &#x21d2; <tt>Hash</tt>
388
+
389
+
390
+
391
+
392
+
393
+ </h3><div class="docstring">
394
+ <div class="discussion">
395
+ <p>Create a new record.</p>
396
+
397
+
398
+ </div>
399
+ </div>
400
+ <div class="tags">
401
+
402
+ <div class="examples">
403
+ <h4 class="tag_title">Examples:</h4>
404
+
405
+
406
+ <h5 class="example_title"><div class='inline'><p>Create a person</p>
407
+ </div></h5>
408
+
409
+ <pre class="example code"><code><span class='id identifier rubyid_record'>record</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_records'>records</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
410
+ <span class='label'>object:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>people</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
411
+ <span class='label'>data:</span> <span class='lbrace'>{</span>
412
+ <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Jane Doe</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
413
+ <span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>jane@example.com</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
414
+ <span class='label'>company:</span> <span class='lbrace'>{</span> <span class='label'>target_object:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>companies</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>target_record_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>company123</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
415
+ <span class='rbrace'>}</span>
416
+ <span class='rparen'>)</span></code></pre>
417
+
418
+ </div>
419
+ <p class="tag_title">Parameters:</p>
420
+ <ul class="param">
421
+
422
+ <li>
423
+
424
+ <span class='name'>object</span>
425
+
426
+
427
+ <span class='type'>(<tt>String</tt>)</span>
428
+
429
+
430
+
431
+ &mdash;
432
+ <div class='inline'><p>The object type to create the record in</p>
433
+ </div>
434
+
435
+ </li>
436
+
437
+ <li>
438
+
439
+ <span class='name'>data</span>
440
+
441
+
442
+ <span class='type'>(<tt>Hash</tt>)</span>
443
+
444
+
445
+
446
+ &mdash;
447
+ <div class='inline'><p>The record data to create</p>
448
+ </div>
449
+
450
+ </li>
451
+
452
+ </ul>
453
+
454
+ <p class="tag_title">Returns:</p>
455
+ <ul class="return">
456
+
457
+ <li>
458
+
459
+
460
+ <span class='type'>(<tt>Hash</tt>)</span>
461
+
462
+
463
+
464
+ &mdash;
465
+ <div class='inline'><p>The created record data</p>
466
+ </div>
467
+
468
+ </li>
469
+
470
+ </ul>
471
+ <p class="tag_title">Raises:</p>
472
+ <ul class="raise">
473
+
474
+ <li>
475
+
476
+
477
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
478
+
479
+
480
+
481
+ &mdash;
482
+ <div class='inline'><p>if object is nil/empty or data is invalid</p>
483
+ </div>
484
+
485
+ </li>
486
+
487
+ </ul>
488
+ <p class="tag_title">Since:</p>
489
+ <ul class="since">
490
+
491
+ <li>
492
+
493
+
494
+
495
+
496
+
497
+ <div class='inline'><p>1.0.0</p>
498
+ </div>
499
+
500
+ </li>
501
+
502
+ </ul>
503
+
504
+ </div><table class="source_code">
505
+ <tr>
506
+ <td>
507
+ <pre class="lines">
508
+
509
+
510
+ 83
511
+ 84
512
+ 85
513
+ 86
514
+ 87</pre>
515
+ </td>
516
+ <td>
517
+ <pre class="code"><span class="info file"># File 'lib/attio/resources/records.rb', line 83</span>
518
+
519
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>object:</span><span class='comma'>,</span> <span class='label'>data:</span><span class='rparen'>)</span>
520
+ <span class='id identifier rubyid_validate_object!'>validate_object!</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
521
+ <span class='id identifier rubyid_validate_data!'>validate_data!</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
522
+ <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>objects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object'>object</span><span class='embexpr_end'>}</span><span class='tstring_content'>/records</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
523
+ <span class='kw'>end</span></pre>
524
+ </td>
525
+ </tr>
526
+ </table>
527
+ </div>
528
+
529
+ <div class="method_details ">
530
+ <h3 class="signature " id="delete-instance_method">
531
+
532
+ #<strong>delete</strong>(object:, id:) &#x21d2; <tt>Hash</tt>
533
+
534
+
535
+
536
+
537
+
538
+ </h3><div class="docstring">
539
+ <div class="discussion">
540
+ <p>Delete a record.</p>
541
+
542
+
543
+ </div>
544
+ </div>
545
+ <div class="tags">
546
+
547
+ <div class="examples">
548
+ <h4 class="tag_title">Examples:</h4>
549
+
550
+
551
+ <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_records'>records</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>object:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>people</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>abc123</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
552
+
553
+ </div>
554
+ <p class="tag_title">Parameters:</p>
555
+ <ul class="param">
556
+
557
+ <li>
558
+
559
+ <span class='name'>object</span>
560
+
561
+
562
+ <span class='type'>(<tt>String</tt>)</span>
563
+
564
+
565
+
566
+ &mdash;
567
+ <div class='inline'><p>The object type</p>
568
+ </div>
569
+
570
+ </li>
571
+
572
+ <li>
573
+
574
+ <span class='name'>id</span>
575
+
576
+
577
+ <span class='type'>(<tt>String</tt>)</span>
578
+
579
+
580
+
581
+ &mdash;
582
+ <div class='inline'><p>The record ID to delete</p>
583
+ </div>
584
+
585
+ </li>
586
+
587
+ </ul>
588
+
589
+ <p class="tag_title">Returns:</p>
590
+ <ul class="return">
591
+
592
+ <li>
593
+
594
+
595
+ <span class='type'>(<tt>Hash</tt>)</span>
596
+
597
+
598
+
599
+ &mdash;
600
+ <div class='inline'><p>Deletion confirmation</p>
601
+ </div>
602
+
603
+ </li>
604
+
605
+ </ul>
606
+ <p class="tag_title">Raises:</p>
607
+ <ul class="raise">
608
+
609
+ <li>
610
+
611
+
612
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
613
+
614
+
615
+
616
+ &mdash;
617
+ <div class='inline'><p>if object or id is nil or empty</p>
618
+ </div>
619
+
620
+ </li>
621
+
622
+ </ul>
623
+ <p class="tag_title">Since:</p>
624
+ <ul class="since">
625
+
626
+ <li>
627
+
628
+
629
+
630
+
631
+
632
+ <div class='inline'><p>1.0.0</p>
633
+ </div>
634
+
635
+ </li>
636
+
637
+ </ul>
638
+
639
+ </div><table class="source_code">
640
+ <tr>
641
+ <td>
642
+ <pre class="lines">
643
+
644
+
645
+ 121
646
+ 122
647
+ 123
648
+ 124
649
+ 125</pre>
650
+ </td>
651
+ <td>
652
+ <pre class="code"><span class="info file"># File 'lib/attio/resources/records.rb', line 121</span>
653
+
654
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>object:</span><span class='comma'>,</span> <span class='label'>id:</span><span class='rparen'>)</span>
655
+ <span class='id identifier rubyid_validate_object!'>validate_object!</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
656
+ <span class='id identifier rubyid_validate_id!'>validate_id!</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
657
+ <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>objects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object'>object</span><span class='embexpr_end'>}</span><span class='tstring_content'>/records/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
658
+ <span class='kw'>end</span></pre>
659
+ </td>
660
+ </tr>
661
+ </table>
662
+ </div>
663
+
664
+ <div class="method_details ">
665
+ <h3 class="signature " id="get-instance_method">
666
+
667
+ #<strong>get</strong>(object:, id:) &#x21d2; <tt>Hash</tt>
668
+
669
+
670
+
671
+
672
+
673
+ </h3><div class="docstring">
674
+ <div class="discussion">
675
+ <p>Retrieve a specific record by ID.</p>
676
+
677
+
678
+ </div>
679
+ </div>
680
+ <div class="tags">
681
+
682
+ <div class="examples">
683
+ <h4 class="tag_title">Examples:</h4>
684
+
685
+
686
+ <pre class="example code"><code><span class='id identifier rubyid_record'>record</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_records'>records</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>object:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>people</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>abc123</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
687
+
688
+ </div>
689
+ <p class="tag_title">Parameters:</p>
690
+ <ul class="param">
691
+
692
+ <li>
693
+
694
+ <span class='name'>object</span>
695
+
696
+
697
+ <span class='type'>(<tt>String</tt>)</span>
698
+
699
+
700
+
701
+ &mdash;
702
+ <div class='inline'><p>The object type (e.g., &#39;people&#39;, &#39;companies&#39;)</p>
703
+ </div>
704
+
705
+ </li>
706
+
707
+ <li>
708
+
709
+ <span class='name'>id</span>
710
+
711
+
712
+ <span class='type'>(<tt>String</tt>)</span>
713
+
714
+
715
+
716
+ &mdash;
717
+ <div class='inline'><p>The record ID</p>
718
+ </div>
719
+
720
+ </li>
721
+
722
+ </ul>
723
+
724
+ <p class="tag_title">Returns:</p>
725
+ <ul class="return">
726
+
727
+ <li>
728
+
729
+
730
+ <span class='type'>(<tt>Hash</tt>)</span>
731
+
732
+
733
+
734
+ &mdash;
735
+ <div class='inline'><p>The record data</p>
736
+ </div>
737
+
738
+ </li>
739
+
740
+ </ul>
741
+ <p class="tag_title">Raises:</p>
742
+ <ul class="raise">
743
+
744
+ <li>
745
+
746
+
747
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
748
+
749
+
750
+
751
+ &mdash;
752
+ <div class='inline'><p>if object or id is nil or empty</p>
753
+ </div>
754
+
755
+ </li>
756
+
757
+ </ul>
758
+ <p class="tag_title">Since:</p>
759
+ <ul class="since">
760
+
761
+ <li>
762
+
763
+
764
+
765
+
766
+
767
+ <div class='inline'><p>1.0.0</p>
768
+ </div>
769
+
770
+ </li>
771
+
772
+ </ul>
773
+
774
+ </div><table class="source_code">
775
+ <tr>
776
+ <td>
777
+ <pre class="lines">
778
+
779
+
780
+ 60
781
+ 61
782
+ 62
783
+ 63
784
+ 64</pre>
785
+ </td>
786
+ <td>
787
+ <pre class="code"><span class="info file"># File 'lib/attio/resources/records.rb', line 60</span>
788
+
789
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>object:</span><span class='comma'>,</span> <span class='label'>id:</span><span class='rparen'>)</span>
790
+ <span class='id identifier rubyid_validate_object!'>validate_object!</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
791
+ <span class='id identifier rubyid_validate_id!'>validate_id!</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
792
+ <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>objects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object'>object</span><span class='embexpr_end'>}</span><span class='tstring_content'>/records/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
793
+ <span class='kw'>end</span></pre>
794
+ </td>
795
+ </tr>
796
+ </table>
797
+ </div>
798
+
799
+ <div class="method_details ">
800
+ <h3 class="signature " id="list-instance_method">
801
+
802
+ #<strong>list</strong>(object:, **params) &#x21d2; <tt>Hash</tt>
803
+
804
+
805
+
806
+
807
+
808
+ </h3><div class="docstring">
809
+ <div class="discussion">
810
+ <p>Query and list records for a specific object type.</p>
811
+
812
+ <p>This method allows you to retrieve records with optional filtering,
813
+ sorting, and pagination parameters.</p>
814
+
815
+
816
+ </div>
817
+ </div>
818
+ <div class="tags">
819
+
820
+ <div class="examples">
821
+ <h4 class="tag_title">Examples:</h4>
822
+
823
+
824
+ <h5 class="example_title"><div class='inline'><p>Basic listing</p>
825
+ </div></h5>
826
+
827
+ <pre class="example code"><code><span class='id identifier rubyid_records'>records</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_records'>records</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>object:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>people</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
828
+
829
+
830
+ <h5 class="example_title"><div class='inline'><p>With filters</p>
831
+ </div></h5>
832
+
833
+ <pre class="example code"><code><span class='id identifier rubyid_records'>records</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_records'>records</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
834
+ <span class='label'>object:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>people</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
835
+ <span class='label'>filters:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='lbrace'>{</span> <span class='label'>contains:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>John</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span> <span class='rbrace'>}</span><span class='comma'>,</span>
836
+ <span class='label'>limit:</span> <span class='int'>50</span>
837
+ <span class='rparen'>)</span></code></pre>
838
+
839
+ </div>
840
+ <p class="tag_title">Parameters:</p>
841
+ <ul class="param">
842
+
843
+ <li>
844
+
845
+ <span class='name'>object</span>
846
+
847
+
848
+ <span class='type'>(<tt>String</tt>)</span>
849
+
850
+
851
+
852
+ &mdash;
853
+ <div class='inline'><p>The object type to query (e.g., &#39;people&#39;, &#39;companies&#39;)</p>
854
+ </div>
855
+
856
+ </li>
857
+
858
+ <li>
859
+
860
+ <span class='name'>params</span>
861
+
862
+
863
+ <span class='type'>(<tt>Hash</tt>)</span>
864
+
865
+
866
+
867
+ &mdash;
868
+ <div class='inline'><p>Query parameters including filters, sorts, and pagination</p>
869
+ </div>
870
+
871
+ </li>
872
+
873
+ </ul>
874
+
875
+
876
+
877
+
878
+
879
+
880
+ <p class="tag_title">Options Hash (<tt>**params</tt>):</p>
881
+ <ul class="option">
882
+
883
+ <li>
884
+ <span class="name">:filters</span>
885
+ <span class="type">(<tt>Hash</tt>)</span>
886
+ <span class="default">
887
+
888
+ </span>
889
+
890
+ &mdash; <div class='inline'><p>Filtering criteria</p>
891
+ </div>
892
+
893
+ </li>
894
+
895
+ <li>
896
+ <span class="name">:sorts</span>
897
+ <span class="type">(<tt>Array</tt>)</span>
898
+ <span class="default">
899
+
900
+ </span>
901
+
902
+ &mdash; <div class='inline'><p>Sorting options</p>
903
+ </div>
904
+
905
+ </li>
906
+
907
+ <li>
908
+ <span class="name">:limit</span>
909
+ <span class="type">(<tt>Integer</tt>)</span>
910
+ <span class="default">
911
+
912
+ </span>
913
+
914
+ &mdash; <div class='inline'><p>Number of records to return</p>
915
+ </div>
916
+
917
+ </li>
918
+
919
+ <li>
920
+ <span class="name">:cursor</span>
921
+ <span class="type">(<tt>String</tt>)</span>
922
+ <span class="default">
923
+
924
+ </span>
925
+
926
+ &mdash; <div class='inline'><p>Pagination cursor for next page</p>
927
+ </div>
928
+
929
+ </li>
930
+
931
+ </ul>
932
+
933
+
934
+ <p class="tag_title">Returns:</p>
935
+ <ul class="return">
936
+
937
+ <li>
938
+
939
+
940
+ <span class='type'>(<tt>Hash</tt>)</span>
941
+
942
+
943
+
944
+ &mdash;
945
+ <div class='inline'><p>API response containing records and pagination info</p>
946
+ </div>
947
+
948
+ </li>
949
+
950
+ </ul>
951
+ <p class="tag_title">Raises:</p>
952
+ <ul class="raise">
953
+
954
+ <li>
955
+
956
+
957
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
958
+
959
+
960
+
961
+ &mdash;
962
+ <div class='inline'><p>if object is nil or empty</p>
963
+ </div>
964
+
965
+ </li>
966
+
967
+ </ul>
968
+ <p class="tag_title">Since:</p>
969
+ <ul class="since">
970
+
971
+ <li>
972
+
973
+
974
+
975
+
976
+
977
+ <div class='inline'><p>1.0.0</p>
978
+ </div>
979
+
980
+ </li>
981
+
982
+ </ul>
983
+
984
+ </div><table class="source_code">
985
+ <tr>
986
+ <td>
987
+ <pre class="lines">
988
+
989
+
990
+ 45
991
+ 46
992
+ 47
993
+ 48</pre>
994
+ </td>
995
+ <td>
996
+ <pre class="code"><span class="info file"># File 'lib/attio/resources/records.rb', line 45</span>
997
+
998
+ <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>object:</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
999
+ <span class='id identifier rubyid_validate_object!'>validate_object!</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
1000
+ <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>objects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object'>object</span><span class='embexpr_end'>}</span><span class='tstring_content'>/records/query</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
1001
+ <span class='kw'>end</span></pre>
1002
+ </td>
1003
+ </tr>
1004
+ </table>
1005
+ </div>
1006
+
1007
+ <div class="method_details ">
1008
+ <h3 class="signature " id="update-instance_method">
1009
+
1010
+ #<strong>update</strong>(object:, id:, data:) &#x21d2; <tt>Hash</tt>
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+ </h3><div class="docstring">
1017
+ <div class="discussion">
1018
+ <p>Update an existing record.</p>
1019
+
1020
+
1021
+ </div>
1022
+ </div>
1023
+ <div class="tags">
1024
+
1025
+ <div class="examples">
1026
+ <h4 class="tag_title">Examples:</h4>
1027
+
1028
+
1029
+ <h5 class="example_title"><div class='inline'><p>Update a person&#39;s name</p>
1030
+ </div></h5>
1031
+
1032
+ <pre class="example code"><code><span class='id identifier rubyid_record'>record</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_records'>records</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1033
+ <span class='label'>object:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>people</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
1034
+ <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>abc123</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
1035
+ <span class='label'>data:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Jane Smith</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
1036
+ <span class='rparen'>)</span></code></pre>
1037
+
1038
+ </div>
1039
+ <p class="tag_title">Parameters:</p>
1040
+ <ul class="param">
1041
+
1042
+ <li>
1043
+
1044
+ <span class='name'>object</span>
1045
+
1046
+
1047
+ <span class='type'>(<tt>String</tt>)</span>
1048
+
1049
+
1050
+
1051
+ &mdash;
1052
+ <div class='inline'><p>The object type</p>
1053
+ </div>
1054
+
1055
+ </li>
1056
+
1057
+ <li>
1058
+
1059
+ <span class='name'>id</span>
1060
+
1061
+
1062
+ <span class='type'>(<tt>String</tt>)</span>
1063
+
1064
+
1065
+
1066
+ &mdash;
1067
+ <div class='inline'><p>The record ID to update</p>
1068
+ </div>
1069
+
1070
+ </li>
1071
+
1072
+ <li>
1073
+
1074
+ <span class='name'>data</span>
1075
+
1076
+
1077
+ <span class='type'>(<tt>Hash</tt>)</span>
1078
+
1079
+
1080
+
1081
+ &mdash;
1082
+ <div class='inline'><p>The updated record data</p>
1083
+ </div>
1084
+
1085
+ </li>
1086
+
1087
+ </ul>
1088
+
1089
+ <p class="tag_title">Returns:</p>
1090
+ <ul class="return">
1091
+
1092
+ <li>
1093
+
1094
+
1095
+ <span class='type'>(<tt>Hash</tt>)</span>
1096
+
1097
+
1098
+
1099
+ &mdash;
1100
+ <div class='inline'><p>The updated record data</p>
1101
+ </div>
1102
+
1103
+ </li>
1104
+
1105
+ </ul>
1106
+ <p class="tag_title">Raises:</p>
1107
+ <ul class="raise">
1108
+
1109
+ <li>
1110
+
1111
+
1112
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
1113
+
1114
+
1115
+
1116
+ &mdash;
1117
+ <div class='inline'><p>if object, id, or data is invalid</p>
1118
+ </div>
1119
+
1120
+ </li>
1121
+
1122
+ </ul>
1123
+ <p class="tag_title">Since:</p>
1124
+ <ul class="since">
1125
+
1126
+ <li>
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+ <div class='inline'><p>1.0.0</p>
1133
+ </div>
1134
+
1135
+ </li>
1136
+
1137
+ </ul>
1138
+
1139
+ </div><table class="source_code">
1140
+ <tr>
1141
+ <td>
1142
+ <pre class="lines">
1143
+
1144
+
1145
+ 104
1146
+ 105
1147
+ 106
1148
+ 107
1149
+ 108
1150
+ 109</pre>
1151
+ </td>
1152
+ <td>
1153
+ <pre class="code"><span class="info file"># File 'lib/attio/resources/records.rb', line 104</span>
1154
+
1155
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>object:</span><span class='comma'>,</span> <span class='label'>id:</span><span class='comma'>,</span> <span class='label'>data:</span><span class='rparen'>)</span>
1156
+ <span class='id identifier rubyid_validate_object!'>validate_object!</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
1157
+ <span class='id identifier rubyid_validate_id!'>validate_id!</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1158
+ <span class='id identifier rubyid_validate_data!'>validate_data!</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1159
+ <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:patch</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>objects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object'>object</span><span class='embexpr_end'>}</span><span class='tstring_content'>/records/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1160
+ <span class='kw'>end</span></pre>
1161
+ </td>
1162
+ </tr>
1163
+ </table>
1164
+ </div>
1165
+
1166
+ <div class="method_details ">
1167
+ <h3 class="signature " id="validate_data!-instance_method">
1168
+
1169
+ #<strong>validate_data!</strong>(data) &#x21d2; <tt>Object</tt> <span class="extras">(private)</span>
1170
+
1171
+
1172
+
1173
+
1174
+
1175
+ </h3><div class="docstring">
1176
+ <div class="discussion">
1177
+ <p class="note private">
1178
+ <strong>This method is part of a private API.</strong>
1179
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
1180
+ </p>
1181
+ <p>Validates that the data parameter is present and is a hash.</p>
1182
+
1183
+
1184
+ </div>
1185
+ </div>
1186
+ <div class="tags">
1187
+ <p class="tag_title">Parameters:</p>
1188
+ <ul class="param">
1189
+
1190
+ <li>
1191
+
1192
+ <span class='name'>data</span>
1193
+
1194
+
1195
+ <span class='type'>(<tt>Hash</tt>, <tt>nil</tt>)</span>
1196
+
1197
+
1198
+
1199
+ &mdash;
1200
+ <div class='inline'><p>The data to validate</p>
1201
+ </div>
1202
+
1203
+ </li>
1204
+
1205
+ </ul>
1206
+
1207
+ <p class="tag_title">Raises:</p>
1208
+ <ul class="raise">
1209
+
1210
+ <li>
1211
+
1212
+
1213
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
1214
+
1215
+
1216
+
1217
+ &mdash;
1218
+ <div class='inline'><p>if data is nil or not a hash</p>
1219
+ </div>
1220
+
1221
+ </li>
1222
+
1223
+ </ul>
1224
+ <p class="tag_title">Since:</p>
1225
+ <ul class="since">
1226
+
1227
+ <li>
1228
+
1229
+
1230
+
1231
+
1232
+
1233
+ <div class='inline'><p>1.0.0</p>
1234
+ </div>
1235
+
1236
+ </li>
1237
+
1238
+ </ul>
1239
+
1240
+ </div><table class="source_code">
1241
+ <tr>
1242
+ <td>
1243
+ <pre class="lines">
1244
+
1245
+
1246
+ 152
1247
+ 153
1248
+ 154
1249
+ 155</pre>
1250
+ </td>
1251
+ <td>
1252
+ <pre class="code"><span class="info file"># File 'lib/attio/resources/records.rb', line 152</span>
1253
+
1254
+ <span class='kw'>def</span> <span class='id identifier rubyid_validate_data!'>validate_data!</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1255
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Data is required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1256
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Data must be a hash</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
1257
+ <span class='kw'>end</span></pre>
1258
+ </td>
1259
+ </tr>
1260
+ </table>
1261
+ </div>
1262
+
1263
+ <div class="method_details ">
1264
+ <h3 class="signature " id="validate_id!-instance_method">
1265
+
1266
+ #<strong>validate_id!</strong>(id) &#x21d2; <tt>Object</tt> <span class="extras">(private)</span>
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+ </h3><div class="docstring">
1273
+ <div class="discussion">
1274
+ <p class="note private">
1275
+ <strong>This method is part of a private API.</strong>
1276
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
1277
+ </p>
1278
+ <p>Validates that the ID parameter is present and not empty.</p>
1279
+
1280
+
1281
+ </div>
1282
+ </div>
1283
+ <div class="tags">
1284
+ <p class="tag_title">Parameters:</p>
1285
+ <ul class="param">
1286
+
1287
+ <li>
1288
+
1289
+ <span class='name'>id</span>
1290
+
1291
+
1292
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
1293
+
1294
+
1295
+
1296
+ &mdash;
1297
+ <div class='inline'><p>The record ID to validate</p>
1298
+ </div>
1299
+
1300
+ </li>
1301
+
1302
+ </ul>
1303
+
1304
+ <p class="tag_title">Raises:</p>
1305
+ <ul class="raise">
1306
+
1307
+ <li>
1308
+
1309
+
1310
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
1311
+
1312
+
1313
+
1314
+ &mdash;
1315
+ <div class='inline'><p>if id is nil or empty</p>
1316
+ </div>
1317
+
1318
+ </li>
1319
+
1320
+ </ul>
1321
+ <p class="tag_title">Since:</p>
1322
+ <ul class="since">
1323
+
1324
+ <li>
1325
+
1326
+
1327
+
1328
+
1329
+
1330
+ <div class='inline'><p>1.0.0</p>
1331
+ </div>
1332
+
1333
+ </li>
1334
+
1335
+ </ul>
1336
+
1337
+ </div><table class="source_code">
1338
+ <tr>
1339
+ <td>
1340
+ <pre class="lines">
1341
+
1342
+
1343
+ 143
1344
+ 144
1345
+ 145</pre>
1346
+ </td>
1347
+ <td>
1348
+ <pre class="code"><span class="info file"># File 'lib/attio/resources/records.rb', line 143</span>
1349
+
1350
+ <span class='kw'>def</span> <span class='id identifier rubyid_validate_id!'>validate_id!</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1351
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Record ID is required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
1352
+ <span class='kw'>end</span></pre>
1353
+ </td>
1354
+ </tr>
1355
+ </table>
1356
+ </div>
1357
+
1358
+ <div class="method_details ">
1359
+ <h3 class="signature " id="validate_object!-instance_method">
1360
+
1361
+ #<strong>validate_object!</strong>(object) &#x21d2; <tt>Object</tt> <span class="extras">(private)</span>
1362
+
1363
+
1364
+
1365
+
1366
+
1367
+ </h3><div class="docstring">
1368
+ <div class="discussion">
1369
+ <p class="note private">
1370
+ <strong>This method is part of a private API.</strong>
1371
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
1372
+ </p>
1373
+ <p>Validates that the object parameter is present and not empty.</p>
1374
+
1375
+
1376
+ </div>
1377
+ </div>
1378
+ <div class="tags">
1379
+ <p class="tag_title">Parameters:</p>
1380
+ <ul class="param">
1381
+
1382
+ <li>
1383
+
1384
+ <span class='name'>object</span>
1385
+
1386
+
1387
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
1388
+
1389
+
1390
+
1391
+ &mdash;
1392
+ <div class='inline'><p>The object type to validate</p>
1393
+ </div>
1394
+
1395
+ </li>
1396
+
1397
+ </ul>
1398
+
1399
+ <p class="tag_title">Raises:</p>
1400
+ <ul class="raise">
1401
+
1402
+ <li>
1403
+
1404
+
1405
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
1406
+
1407
+
1408
+
1409
+ &mdash;
1410
+ <div class='inline'><p>if object is nil or empty</p>
1411
+ </div>
1412
+
1413
+ </li>
1414
+
1415
+ </ul>
1416
+ <p class="tag_title">Since:</p>
1417
+ <ul class="since">
1418
+
1419
+ <li>
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+ <div class='inline'><p>1.0.0</p>
1426
+ </div>
1427
+
1428
+ </li>
1429
+
1430
+ </ul>
1431
+
1432
+ </div><table class="source_code">
1433
+ <tr>
1434
+ <td>
1435
+ <pre class="lines">
1436
+
1437
+
1438
+ 134
1439
+ 135
1440
+ 136</pre>
1441
+ </td>
1442
+ <td>
1443
+ <pre class="code"><span class="info file"># File 'lib/attio/resources/records.rb', line 134</span>
1444
+
1445
+ <span class='kw'>def</span> <span class='id identifier rubyid_validate_object!'>validate_object!</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
1446
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Object type is required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
1447
+ <span class='kw'>end</span></pre>
1448
+ </td>
1449
+ </tr>
1450
+ </table>
1451
+ </div>
1452
+
1453
+ </div>
1454
+
1455
+ </div>
1456
+
1457
+ <div id="footer">
1458
+ Generated on Mon Aug 11 11:26:44 2025 by
1459
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1460
+ 0.9.37 (ruby-3.4.5).
1461
+ </div>
1462
+
1463
+ </div>
1464
+ </body>
1465
+ </html>