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