This repository has been archived by the owner on Sep 26, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathteos.gatekeeper.html
469 lines (333 loc) · 23.9 KB
/
teos.gatekeeper.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>teos.gatekeeper — pyton-teos documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="teos.inspector" href="teos.inspector.html" />
<link rel="prev" title="teos.extended_appointment" href="teos.extended_appointment.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> pyton-teos
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="teos.html">teos package</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="teos.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="teos.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="teos.api.html">teos.api</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.appointments_dbm.html">teos.appointments_dbm</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.block_processor.html">teos.block_processor</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.builder.html">teos.builder</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.carrier.html">teos.carrier</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.chain_monitor.html">teos.chain_monitor</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.cleaner.html">teos.cleaner</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.extended_appointment.html">teos.extended_appointment</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">teos.gatekeeper</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.inspector.html">teos.inspector</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.internal_api.html">teos.internal_api</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.lightning_server.html">teos.lightning_server</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.logger.html">teos.logger</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.responder.html">teos.responder</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.rpc.html">teos.rpc</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.teosd.html">teos.teosd</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.tools.html">teos.tools</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.users_dbm.html">teos.users_dbm</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.watcher.html">teos.watcher</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="common.html">common package</a></li>
<li class="toctree-l1"><a class="reference internal" href="contrib.html">contrib package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pyton-teos</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="teos.html">teos package</a> »</li>
<li>teos.gatekeeper</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/teos.gatekeeper.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-teos.gatekeeper">
<span id="teos-gatekeeper"></span><h1>teos.gatekeeper<a class="headerlink" href="#module-teos.gatekeeper" title="Permalink to this headline">¶</a></h1>
<dl class="py exception">
<dt id="teos.gatekeeper.AuthenticationFailure">
<em class="property">exception </em><code class="sig-name descname">AuthenticationFailure</code><a class="reference internal" href="_modules/teos/gatekeeper.html#AuthenticationFailure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.AuthenticationFailure" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>Raised when a user can not be authenticated. Either the user public key cannot be recovered or the user is
not found within the registered ones.</p>
</dd></dl>
<dl class="py class">
<dt id="teos.gatekeeper.Gatekeeper">
<em class="property">class </em><code class="sig-name descname">Gatekeeper</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user_db</span></em>, <em class="sig-param"><span class="n">block_processor</span></em>, <em class="sig-param"><span class="n">subscription_slots</span></em>, <em class="sig-param"><span class="n">subscription_duration</span></em>, <em class="sig-param"><span class="n">expiry_delta</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/gatekeeper.html#Gatekeeper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.Gatekeeper" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The <a class="reference internal" href="#teos.gatekeeper.Gatekeeper" title="teos.gatekeeper.Gatekeeper"><code class="xref py py-class docutils literal notranslate"><span class="pre">Gatekeeper</span></code></a> is in charge of managing the access to the tower. Only registered users are allowed to
perform actions.</p>
<dl class="py attribute">
<dt id="teos.gatekeeper.Gatekeeper.subscription_slots">
<code class="sig-name descname">subscription_slots</code><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.subscription_slots" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of slots assigned to a user subscription.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.gatekeeper.Gatekeeper.subscription_duration">
<code class="sig-name descname">subscription_duration</code><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.subscription_duration" title="Permalink to this definition">¶</a></dt>
<dd><p>The expiry assigned to a user subscription.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.gatekeeper.Gatekeeper.expiry_delta">
<code class="sig-name descname">expiry_delta</code><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.expiry_delta" title="Permalink to this definition">¶</a></dt>
<dd><p>The grace period given to the user to renew their subscription.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.gatekeeper.Gatekeeper.block_processor">
<code class="sig-name descname">block_processor</code><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.block_processor" title="Permalink to this definition">¶</a></dt>
<dd><p>A block processor instance to
get block from bitcoind.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="teos.block_processor.html#teos.block_processor.BlockProcessor" title="teos.block_processor.BlockProcessor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BlockProcessor</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.gatekeeper.Gatekeeper.user_db">
<code class="sig-name descname">user_db</code><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.user_db" title="Permalink to this definition">¶</a></dt>
<dd><p>A user database manager instance to interact with the
database.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">UsersDBM</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.gatekeeper.Gatekeeper.registered_users">
<code class="sig-name descname">registered_users</code><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.registered_users" title="Permalink to this definition">¶</a></dt>
<dd><p>A map of <code class="docutils literal notranslate"><span class="pre">user_pk:user_info</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.gatekeeper.Gatekeeper.lock">
<code class="sig-name descname">lock</code><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.lock" title="Permalink to this definition">¶</a></dt>
<dd><p>A lock object to lock access to the Gatekeeper on updates.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Lock</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.gatekeeper.Gatekeeper.add_update_appointment">
<code class="sig-name descname">add_update_appointment</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user_id</span></em>, <em class="sig-param"><span class="n">uuid</span></em>, <em class="sig-param"><span class="n">appointment</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/gatekeeper.html#Gatekeeper.add_update_appointment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.add_update_appointment" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds (or updates) an appointment to a user subscription. The user slots are updated accordingly.</p>
<p>Slots are taken if a new appointment is given, or an update is given with an appointment bigger than the
existing one.</p>
<p>Slots are given back if an update is given but the new appointment is smaller than the existing one.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>user_id</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the public key that identifies the user (33-bytes hex str).</p></li>
<li><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the appointment uuid.</p></li>
<li><p><strong>appointment</strong> (<a class="reference internal" href="teos.extended_appointment.html#teos.extended_appointment.ExtendedAppointment" title="teos.extended_appointment.ExtendedAppointment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ExtendedAppointment</span></code></a>) – the summary of new
appointment the user is requesting.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The number of remaining appointment slots.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><a class="reference internal" href="#teos.gatekeeper.NotEnoughSlots" title="teos.gatekeeper.NotEnoughSlots"><strong>NotEnoughSlots</strong></a> – if the user does not have enough slots to fill.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.gatekeeper.Gatekeeper.add_update_user">
<code class="sig-name descname">add_update_user</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user_id</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/gatekeeper.html#Gatekeeper.add_update_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.add_update_user" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a new user or updates the subscription of an existing one, by adding additional slots.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>user_id</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the public key that identifies the user (33-bytes hex str).</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A tuple with the number of available slots in the user subscription, the subscription
expiry (in absolute block height), and the registration_receipt.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">tuple</span></code></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><a class="reference internal" href="common.exceptions.html#common.exceptions.InvalidParameter" title="common.exceptions.InvalidParameter"><strong>InvalidParameter</strong></a> – if the user_pk does not match the expected format.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.gatekeeper.Gatekeeper.authenticate_user">
<code class="sig-name descname">authenticate_user</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">signature</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/gatekeeper.html#Gatekeeper.authenticate_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.authenticate_user" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if a request comes from a registered user by ec-recovering their public key from a signed message.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>message</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bytes</span></code>) – byte representation of the original message from where the signature was generated.</p></li>
<li><p><strong>signature</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the user’s signature (hex-encoded).</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A compressed key recovered from the signature and matching a registered user.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><a class="reference internal" href="#teos.gatekeeper.AuthenticationFailure" title="teos.gatekeeper.AuthenticationFailure"><strong>AuthenticationFailure</strong></a> – if the user cannot be authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.gatekeeper.Gatekeeper.get_expired_appointments">
<code class="sig-name descname">get_expired_appointments</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">block_height</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/gatekeeper.html#Gatekeeper.get_expired_appointments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.Gatekeeper.get_expired_appointments" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a list of appointments that expire at a given block height.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>block_height</strong> – the block height that wants to be checked.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of appointment uuids that will expire at <code class="docutils literal notranslate"><span class="pre">block_height</span></code>.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py exception">
<dt id="teos.gatekeeper.NotEnoughSlots">
<em class="property">exception </em><code class="sig-name descname">NotEnoughSlots</code><a class="reference internal" href="_modules/teos/gatekeeper.html#NotEnoughSlots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.NotEnoughSlots" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
<p>Raised when trying to subtract more slots than a user has available.</p>
</dd></dl>
<dl class="py class">
<dt id="teos.gatekeeper.UserInfo">
<em class="property">class </em><code class="sig-name descname">UserInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">available_slots</span></em>, <em class="sig-param"><span class="n">subscription_expiry</span></em>, <em class="sig-param"><span class="n">appointments</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/gatekeeper.html#UserInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.UserInfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Class used to stored information about a user.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>available_slots</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>) – the number of appointment slots available to the user.</p></li>
<li><p><strong>subscription_expiry</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>) – the block height when the user subscription will expire.</p></li>
<li><p><strong>appointments</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dictionary containing the current appointments of the user. Optional.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt id="teos.gatekeeper.UserInfo.from_dict">
<em class="property">classmethod </em><code class="sig-name descname">from_dict</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user_data</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/gatekeeper.html#UserInfo.from_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.UserInfo.from_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <a class="reference internal" href="#teos.gatekeeper.UserInfo" title="teos.gatekeeper.UserInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UserInfo</span></code></a> instance from a dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>user_data</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dictionary containing all the necessary <code class="docutils literal notranslate"><span class="pre">key:value</span></code> pairs.</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>ValueError</strong> – if any of the dictionary entries is missing.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.gatekeeper.UserInfo.to_dict">
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/gatekeeper.html#UserInfo.to_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.gatekeeper.UserInfo.to_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts a <a class="reference internal" href="#teos.gatekeeper.UserInfo" title="teos.gatekeeper.UserInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UserInfo</span></code></a> instance in a dictionary.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="teos.inspector.html" class="btn btn-neutral float-right" title="teos.inspector" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="teos.extended_appointment.html" class="btn btn-neutral float-left" title="teos.extended_appointment" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, Talaia Labs
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>