asc/pyteamsnap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
852acafcae75d7df1e76fcc64f6f60e02e9a2306
pyteamsnap/docs/pyteamsnap.models.html

684 lines
58 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pyteamsnap.models package &mdash; pyteamsnap 0.1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="pyteamsnap package" href="pyteamsnap.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"> pyteamsnap
</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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">pyteamsnap</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="pyteamsnap.html">pyteamsnap package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="pyteamsnap.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#">pyteamsnap.models package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyteamsnap.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyteamsnap.html#module-pyteamsnap.client">pyteamsnap.client module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyteamsnap.html#module-pyteamsnap">Module contents</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pyteamsnap</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="modules.html">pyteamsnap</a></li>
<li class="breadcrumb-item"><a href="pyteamsnap.html">pyteamsnap package</a></li>
<li class="breadcrumb-item active">pyteamsnap.models package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/pyteamsnap.models.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">
<section id="pyteamsnap-models-package">
<h1>pyteamsnap.models package<a class="headerlink" href="#pyteamsnap-models-package" title="Permalink to this heading"></a></h1>
<section id="module-pyteamsnap.models">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyteamsnap.models" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.Availability">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">Availability</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.Availability" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.Availability.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.Availability.data" title="Permalink to this definition"></a></dt>
<dd><p>Data dictionary for object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with keys:</p>
</dd>
</dl>
<ul class="simple">
<li><p>event_id</p></li>
<li><p>member_id</p></li>
<li><p>notes</p></li>
<li><p>notes_author_member_id</p></li>
<li><p>source</p></li>
<li><p>status_code</p></li>
<li><p>type</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Availability.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availabilities'</span></em><a class="headerlink" href="#pyteamsnap.models.Availability.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Availability.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availability'</span></em><a class="headerlink" href="#pyteamsnap.models.Availability.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Availability.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.Availability.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.AvailabilitySummary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">AvailabilitySummary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.AvailabilitySummary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.AvailabilitySummary.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.AvailabilitySummary.data" title="Permalink to this definition"></a></dt>
<dd><p>Data dictionary for object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with keys:</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.AvailabilitySummary.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availability_summaries'</span></em><a class="headerlink" href="#pyteamsnap.models.AvailabilitySummary.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.AvailabilitySummary.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availability_summary'</span></em><a class="headerlink" href="#pyteamsnap.models.AvailabilitySummary.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.AvailabilitySummary.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.AvailabilitySummary.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.Event">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">Event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.Event" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<p>Associated object to a team; and represents an event or game that is tracked in the TeamSnap system.
<a class="reference external" href="https://www.teamsnap.com/documentation/apiv3/objects#Events">https://www.teamsnap.com/documentation/apiv3/objects#Events</a></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.Event.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.Event.data" title="Permalink to this definition"></a></dt>
<dd><p>Data dictionary for object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with strings:</p>
</dd>
</dl>
<ul class="simple">
<li><p>type</p></li>
<li><p>additional_location_details</p></li>
<li><p>browser_time_zone</p></li>
<li><p>division_location_id</p></li>
<li><p>doesnt_count_towards_record</p></li>
<li><p>duration_in_minutes</p></li>
<li><p>game_type_code</p></li>
<li><p>icon_color</p></li>
<li><p>is_canceled</p></li>
<li><p>is_game</p></li>
<li><p>is_overtime</p></li>
<li><p>is_shootout</p></li>
<li><p>is_tbd</p></li>
<li><p>label</p></li>
<li><p>location_id</p></li>
<li><p>minutes_to_arrive_early</p></li>
<li><p>name</p></li>
<li><p>notes</p></li>
<li><p>notify_opponent</p></li>
<li><p>notify_opponent_contacts_email</p></li>
<li><p>notify_opponent_contacts_name</p></li>
<li><p>notify_opponent_notes</p></li>
<li><p>notify_team</p></li>
<li><p>notify_team_as_member_id</p></li>
<li><p>opponent_id</p></li>
<li><p>points_for_opponent</p></li>
<li><p>points_for_team</p></li>
<li><p>repeating_include</p></li>
<li><p>repeating_type_code</p></li>
<li><p>repeating_until</p></li>
<li><p>results</p></li>
<li><p>results_url</p></li>
<li><p>shootout_points_for_opponent</p></li>
<li><p>shootout_points_for_team</p></li>
<li><p>start_date</p></li>
<li><p>team_id</p></li>
<li><p>time_zone</p></li>
<li><p>tracks_availability</p></li>
<li><p>uniform</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Event.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'events'</span></em><a class="headerlink" href="#pyteamsnap.models.Event.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Event.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'event'</span></em><a class="headerlink" href="#pyteamsnap.models.Event.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Event.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.Event.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineup">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">EventLineup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.EventLineup" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineup.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.EventLineup.data" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with strings:</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineup.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'event_lineups'</span></em><a class="headerlink" href="#pyteamsnap.models.EventLineup.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineup.template">
<span class="sig-name descname"><span class="pre">template</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyteamsnap.models.EventLineup.template" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineup.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'event_lineup'</span></em><a class="headerlink" href="#pyteamsnap.models.EventLineup.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineup.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.EventLineup.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineupEntry">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">EventLineupEntry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.EventLineupEntry" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineupEntry.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.EventLineupEntry.data" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with strings:</p>
</dd>
</dl>
<ul class="simple">
<li><p>member_id</p></li>
<li><p>sequence</p></li>
<li><p>label</p></li>
<li><p>type</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineupEntry.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'event_lineup_entries'</span></em><a class="headerlink" href="#pyteamsnap.models.EventLineupEntry.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineupEntry.search">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.EventLineupEntry.search" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineupEntry.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'event_lineup_entry'</span></em><a class="headerlink" href="#pyteamsnap.models.EventLineupEntry.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.EventLineupEntry.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.EventLineupEntry.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.Location">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">Location</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.Location" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.Location.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.Location.data" title="Permalink to this definition"></a></dt>
<dd><p>Data dictionary for object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with keys:</p>
</dd>
</dl>
<ul class="simple">
<li><p>name</p></li>
<li><p>url</p></li>
<li><p>phone</p></li>
<li><p>notes</p></li>
<li><p>address</p></li>
<li><p>latitude</p></li>
<li><p>longitude</p></li>
<li><p>team_id</p></li>
<li><p>is_retired</p></li>
<li><p>type</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Location.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'locations'</span></em><a class="headerlink" href="#pyteamsnap.models.Location.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Location.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'location'</span></em><a class="headerlink" href="#pyteamsnap.models.Location.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Location.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.Location.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.Me">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">Me</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.Me" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyteamsnap.models.User" title="pyteamsnap.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a></p>
<p>The current user’s object. It is not possible to create or delete users via the API;
however, it is possible to update data on a user’s record.
<a class="reference external" href="https://www.teamsnap.com/documentation/apiv3/objects#Me">https://www.teamsnap.com/documentation/apiv3/objects#Me</a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Me.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'me'</span></em><a class="headerlink" href="#pyteamsnap.models.Me.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Me.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'user'</span></em><a class="headerlink" href="#pyteamsnap.models.Me.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Me.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.Me.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.Member">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">Member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.Member" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<p>A member (also referred to as a roster in our web and mobile apps) is a member of a team.
<a class="reference external" href="https://www.teamsnap.com/documentation/apiv3/objects#Members">https://www.teamsnap.com/documentation/apiv3/objects#Members</a></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.Member.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.Member.data" title="Permalink to this definition"></a></dt>
<dd><p>Data dictionary for object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with keys:</p>
</dd>
</dl>
<ul class="simple">
<li><p>first_name</p></li>
<li><p>last_name</p></li>
<li><p>address_city</p></li>
<li><p>address_state</p></li>
<li><p>address_street1</p></li>
<li><p>address_street2</p></li>
<li><p>address_zip</p></li>
<li><p>birthday</p></li>
<li><p>gender</p></li>
<li><p>hide_address</p></li>
<li><p>hide_age</p></li>
<li><p>is_address_hidden</p></li>
<li><p>is_age_hidden</p></li>
<li><p>is_manager</p></li>
<li><p>is_non_player</p></li>
<li><p>is_ownership_pending</p></li>
<li><p>jersey_number</p></li>
<li><p>position</p></li>
<li><p>source_action</p></li>
<li><p>team_id</p></li>
<li><p>type</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Member.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'members'</span></em><a class="headerlink" href="#pyteamsnap.models.Member.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Member.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'member'</span></em><a class="headerlink" href="#pyteamsnap.models.Member.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Member.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.Member.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.MemberStatistics">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">MemberStatistics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.MemberStatistics" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.MemberStatistics.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'member_statistics'</span></em><a class="headerlink" href="#pyteamsnap.models.MemberStatistics.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.Opponent">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">Opponent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.Opponent" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.Opponent.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.Opponent.data" title="Permalink to this definition"></a></dt>
<dd><p>Data dictionary for object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with keys:</p>
</dd>
</dl>
<ul class="simple">
<li><p>name</p></li>
<li><p>contacts_name</p></li>
<li><p>contacts_phone</p></li>
<li><p>contacts_email</p></li>
<li><p>notes</p></li>
<li><p>team_id</p></li>
<li><p>type</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Opponent.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'opponents'</span></em><a class="headerlink" href="#pyteamsnap.models.Opponent.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Opponent.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'opponent'</span></em><a class="headerlink" href="#pyteamsnap.models.Opponent.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Opponent.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.Opponent.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.Statistics">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">Statistics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.Statistics" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.Statistics.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.Statistics.data" title="Permalink to this definition"></a></dt>
<dd><p>Data dictionary for object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with keys:</p>
</dd>
</dl>
<ul class="simple">
<li><p>acronym</p></li>
<li><p>always_display_decimals</p></li>
<li><p>formula</p></li>
<li><p>is_in_descending_order</p></li>
<li><p>display_zero_totals</p></li>
<li><p>is_percentage</p></li>
<li><p>is_private</p></li>
<li><p>is_team_statistic</p></li>
<li><p>is_top_statistic</p></li>
<li><p>name</p></li>
<li><p>precision</p></li>
<li><p>statistic_group_id</p></li>
<li><p>team_id</p></li>
<li><p>type</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Statistics.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'statistics'</span></em><a class="headerlink" href="#pyteamsnap.models.Statistics.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Statistics.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'statistic'</span></em><a class="headerlink" href="#pyteamsnap.models.Statistics.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Statistics.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.Statistics.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.Team">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">Team</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.Team" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<p>Associated teams from your origin object. Full CRUD is possible with the teams endpoint.
<a class="reference external" href="https://www.teamsnap.com/documentation/apiv3/objects#Teams">https://www.teamsnap.com/documentation/apiv3/objects#Teams</a></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.Team.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.Team.data" title="Permalink to this definition"></a></dt>
<dd><p>Data dictionary for object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with keys:</p>
</dd>
</dl>
<ul class="simple">
<li><p>ad_unit_hero_id</p></li>
<li><p>ad_unit_hero_template_id</p></li>
<li><p>ad_unit_inline_id</p></li>
<li><p>division_id</p></li>
<li><p>division_name</p></li>
<li><p>is_ownership_pending</p></li>
<li><p>league_name</p></li>
<li><p>league_url</p></li>
<li><p>location_country</p></li>
<li><p>location_postal_code</p></li>
<li><p>name</p></li>
<li><p>owner_email</p></li>
<li><p>owner_first_name</p></li>
<li><p>owner_last_name</p></li>
<li><p>season_name</p></li>
<li><p>sport_id</p></li>
<li><p>team</p></li>
<li><p>time_zone</p></li>
<li><p>type</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Team.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'teams'</span></em><a class="headerlink" href="#pyteamsnap.models.Team.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Team.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'team'</span></em><a class="headerlink" href="#pyteamsnap.models.Team.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.Team.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.Team.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyteamsnap.models.User">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyteamsnap.models.</span></span><span class="sig-name descname"><span class="pre">User</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">APIClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyteamsnap.models.User" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApiObject</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="pyteamsnap.models.User.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#pyteamsnap.models.User.data" title="Permalink to this definition"></a></dt>
<dd><p>Data dictionary for object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict: dict with keys:</p>
</dd>
</dl>
<ul class="simple">
<li><p>first_name</p></li>
<li><p>last_name</p></li>
<li><p>password</p></li>
<li><p>birthday</p></li>
<li><p>email</p></li>
<li><p>facebook_id</p></li>
<li><p>facebook_access_token</p></li>
<li><p>type</p></li>
<li><p>is_lab_rat</p></li>
<li><p>receives_newsletter</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.User.rel">
<span class="sig-name descname"><span class="pre">rel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'users'</span></em><a class="headerlink" href="#pyteamsnap.models.User.rel" title="Permalink to this definition"></a></dt>
<dd><p>rel: Relationship between a linked resource and the current document</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.User.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'user'</span></em><a class="headerlink" href="#pyteamsnap.models.User.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyteamsnap.models.User.version">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'3.866.0'</span></em><a class="headerlink" href="#pyteamsnap.models.User.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="pyteamsnap.html" class="btn btn-neutral float-left" title="pyteamsnap package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2022, Anthony Correa.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink