Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
384 lines (323 sloc) 18.4 KB
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module pyfoo</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>pyfoo</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/mark/dev/pyfoo/pyfoo.py">/home/mark/dev/pyfoo/pyfoo.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="json.html">json</a><br>
</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
</td><td width="25%" valign=top><a href="urllib2.html">urllib2</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="UserDict.html#UserDict">UserDict.UserDict</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="pyfoo.html#Entry">Entry</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="pyfoo.html#PyfooAPI">PyfooAPI</a>
</font></dt><dt><font face="helvetica, arial"><a href="pyfoo.html#SearchParameter">SearchParameter</a>
</font></dt><dt><font face="helvetica, arial"><a href="pyfoo.html#WufooObject">WufooObject</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="pyfoo.html#Comment">Comment</a>
</font></dt><dt><font face="helvetica, arial"><a href="pyfoo.html#Field">Field</a>
</font></dt><dt><font face="helvetica, arial"><a href="pyfoo.html#Form">Form</a>
</font></dt><dt><font face="helvetica, arial"><a href="pyfoo.html#Report">Report</a>
</font></dt><dt><font face="helvetica, arial"><a href="pyfoo.html#User">User</a>
</font></dt><dt><font face="helvetica, arial"><a href="pyfoo.html#Widget">Widget</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Comment">class <strong>Comment</strong></a>(<a href="pyfoo.html#WufooObject">WufooObject</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyfoo.html#Comment">Comment</a></dd>
<dd><a href="pyfoo.html#WufooObject">WufooObject</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><a name="Comment-__init__"><strong>__init__</strong></a>(self, api, json_object)</dt></dl>
<hr>
Data descriptors inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Entry">class <strong>Entry</strong></a>(<a href="UserDict.html#UserDict">UserDict.UserDict</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Entry-__init__"><strong>__init__</strong></a>(self, fields<font color="#909090">=None</font>, form<font color="#909090">=None</font>)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>comments</strong></dt>
</dl>
<hr>
Methods inherited from <a href="UserDict.html#UserDict">UserDict.UserDict</a>:<br>
<dl><dt><a name="Entry-__cmp__"><strong>__cmp__</strong></a>(self, dict)</dt></dl>
<dl><dt><a name="Entry-__contains__"><strong>__contains__</strong></a>(self, key)</dt></dl>
<dl><dt><a name="Entry-__delitem__"><strong>__delitem__</strong></a>(self, key)</dt></dl>
<dl><dt><a name="Entry-__getitem__"><strong>__getitem__</strong></a>(self, key)</dt></dl>
<dl><dt><a name="Entry-__len__"><strong>__len__</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-__setitem__"><strong>__setitem__</strong></a>(self, key, item)</dt></dl>
<dl><dt><a name="Entry-clear"><strong>clear</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-copy"><strong>copy</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-get"><strong>get</strong></a>(self, key, failobj<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Entry-has_key"><strong>has_key</strong></a>(self, key)</dt></dl>
<dl><dt><a name="Entry-items"><strong>items</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-iteritems"><strong>iteritems</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-iterkeys"><strong>iterkeys</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-itervalues"><strong>itervalues</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-keys"><strong>keys</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-pop"><strong>pop</strong></a>(self, key, *args)</dt></dl>
<dl><dt><a name="Entry-popitem"><strong>popitem</strong></a>(self)</dt></dl>
<dl><dt><a name="Entry-setdefault"><strong>setdefault</strong></a>(self, key, failobj<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Entry-update"><strong>update</strong></a>(self, dict<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="Entry-values"><strong>values</strong></a>(self)</dt></dl>
<hr>
Class methods inherited from <a href="UserDict.html#UserDict">UserDict.UserDict</a>:<br>
<dl><dt><a name="Entry-fromkeys"><strong>fromkeys</strong></a>(cls, iterable, value<font color="#909090">=None</font>)<font color="#909090"><font face="helvetica, arial"> from __builtin__.classobj</font></font></dt></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Field">class <strong>Field</strong></a>(<a href="pyfoo.html#WufooObject">WufooObject</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyfoo.html#Field">Field</a></dd>
<dd><a href="pyfoo.html#WufooObject">WufooObject</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Field-__init__"><strong>__init__</strong></a>(self, api, json_object)</dt></dl>
<hr>
Data descriptors inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Form">class <strong>Form</strong></a>(<a href="pyfoo.html#WufooObject">WufooObject</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyfoo.html#Form">Form</a></dd>
<dd><a href="pyfoo.html#WufooObject">WufooObject</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Form-add_entry"><strong>add_entry</strong></a>(self, entry)</dt></dl>
<dl><dt><a name="Form-add_web_hook"><strong>add_web_hook</strong></a>(self, hook_url, handshake_key<font color="#909090">=None</font>, send_metadata<font color="#909090">=True</font>)</dt></dl>
<dl><dt><a name="Form-delete_web_hook"><strong>delete_web_hook</strong></a>(self, webhook_hash)</dt></dl>
<dl><dt><a name="Form-get_entries"><strong>get_entries</strong></a>(self, page_start<font color="#909090">=0</font>, page_size<font color="#909090">=100</font>, sort_field<font color="#909090">='DateCreated'</font>, sort_direction<font color="#909090">='DESC'</font>, filter_string<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Form-get_iframe_embed_url"><strong>get_iframe_embed_url</strong></a>(self)</dt></dl>
<dl><dt><a name="Form-get_javascript_embed_url"><strong>get_javascript_embed_url</strong></a>(self)</dt></dl>
<dl><dt><a name="Form-get_link_url"><strong>get_link_url</strong></a>(self)</dt></dl>
<dl><dt><a name="Form-search_entries"><strong>search_entries</strong></a>(self, parameters)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>comments</strong></dt>
</dl>
<dl><dt><strong>entry_count</strong></dt>
</dl>
<dl><dt><strong>fields</strong></dt>
</dl>
<hr>
Methods inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><a name="Form-__init__"><strong>__init__</strong></a>(self, api, json_object)</dt></dl>
<hr>
Data descriptors inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="PyfooAPI">class <strong>PyfooAPI</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="PyfooAPI-__init__"><strong>__init__</strong></a>(self, account<font color="#909090">=None</font>, api_key<font color="#909090">=None</font>, email<font color="#909090">=None</font>, password<font color="#909090">=None</font>, integration_key<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="PyfooAPI-make_call"><strong>make_call</strong></a>(self, url, post_params<font color="#909090">=None</font>, method<font color="#909090">=None</font>)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>forms</strong></dt>
</dl>
<dl><dt><strong>reports</strong></dt>
</dl>
<dl><dt><strong>users</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Report">class <strong>Report</strong></a>(<a href="pyfoo.html#WufooObject">WufooObject</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyfoo.html#Report">Report</a></dd>
<dd><a href="pyfoo.html#WufooObject">WufooObject</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Report-get_entries"><strong>get_entries</strong></a>(self, page_start<font color="#909090">=0</font>, page_size<font color="#909090">=100</font>)</dt></dl>
<dl><dt><a name="Report-get_link"><strong>get_link</strong></a>(self)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>entries</strong></dt>
</dl>
<dl><dt><strong>entry_count</strong></dt>
</dl>
<dl><dt><strong>fields</strong></dt>
</dl>
<dl><dt><strong>widgets</strong></dt>
</dl>
<hr>
Methods inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><a name="Report-__init__"><strong>__init__</strong></a>(self, api, json_object)</dt></dl>
<hr>
Data descriptors inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="SearchParameter">class <strong>SearchParameter</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="SearchParameter-__init__"><strong>__init__</strong></a>(self, field, operator, value)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="User">class <strong>User</strong></a>(<a href="pyfoo.html#WufooObject">WufooObject</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyfoo.html#User">User</a></dd>
<dd><a href="pyfoo.html#WufooObject">WufooObject</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="User-get_big_image_url"><strong>get_big_image_url</strong></a>(self)</dt></dl>
<dl><dt><a name="User-get_small_image_url"><strong>get_small_image_url</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><a name="User-__init__"><strong>__init__</strong></a>(self, api, json_object)</dt></dl>
<hr>
Data descriptors inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Widget">class <strong>Widget</strong></a>(<a href="pyfoo.html#WufooObject">WufooObject</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyfoo.html#Widget">Widget</a></dd>
<dd><a href="pyfoo.html#WufooObject">WufooObject</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Widget-get_embed_code"><strong>get_embed_code</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><a name="Widget-__init__"><strong>__init__</strong></a>(self, api, json_object)</dt></dl>
<hr>
Data descriptors inherited from <a href="pyfoo.html#WufooObject">WufooObject</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="WufooObject">class <strong>WufooObject</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="WufooObject-__init__"><strong>__init__</strong></a>(self, api, json_object)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>BOOLEAN_FIELDS</strong> = ('IsAccountOwner', 'IsRequired', 'IsPublic', 'CreateForms', 'CreateReports', 'CreateThemes', 'AdminAccess', 'Success')</td></tr></table>
</body></html>