RubyGems - quickbooks - Versions diffs - 0.0.3 → 0.0.5 - Mend

quickbooks 0.0.3 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (186) hide show

data/doc/classes/Quickbooks/ListItem.html CHANGED

@@ -88,7 +88,8 @@
       <h3 class="section-bar">Methods</h3>
       <div class="name-list">
-      <a href="#M000033">child_types</a>&nbsp;&nbsp;
+      <a href="#M000079">ListOrTxn</a>&nbsp;&nbsp;
+      <a href="#M000078">inherited</a>&nbsp;&nbsp;
       </div>
     </div>
@@ -103,44 +104,6 @@
-    <div id="attribute-list">
-      <h3 class="section-bar">Attributes</h3>
-      <div class="name-list">
-        <table>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">edit_sequence</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">full_name</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">is_active</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">list_id</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">time_created</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">time_modified</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        </table>
-      </div>
-    </div>
@@ -148,13 +111,27 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
-      <div id="method-M000033" class="method-detail">
-        <a name="M000033"></a>
+      <div id="method-M000079" class="method-detail">
+        <a name="M000079"></a>
+        <div class="method-heading">
+          <a href="ListItem.src/M000079.html" target="Code" class="method-signature"
+            onclick="popupCode('ListItem.src/M000079.html');return false;">
+          <span class="method-name">ListOrTxn</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000078" class="method-detail">
+        <a name="M000078"></a>
         <div class="method-heading">
-          <a href="ListItem.src/M000033.html" target="Code" class="method-signature"
-            onclick="popupCode('ListItem.src/M000033.html');return false;">
-          <span class="method-name">child_types</span><span class="method-args">()</span>
+          <a href="ListItem.src/M000078.html" target="Code" class="method-signature"
+            onclick="popupCode('ListItem.src/M000078.html');return false;">
+          <span class="method-name">inherited</span><span class="method-args">(klass)</span>
           </a>
         </div>

data/doc/classes/Quickbooks/ListItem.src/M000078.html ADDED

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>inherited (Quickbooks::ListItem)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/quickbooks/models/list_item.rb, line 6</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
+    <span class="ruby-keyword kw">super</span>
+    <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">read_only</span> <span class="ruby-identifier">:list_id</span>, <span class="ruby-identifier">:full_name</span>, <span class="ruby-identifier">:edit_sequence</span>, <span class="ruby-identifier">:time_created</span>, <span class="ruby-identifier">:time_modified</span>
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Quickbooks/ListItem.src/M000079.html ADDED

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>ListOrTxn (Quickbooks::ListItem)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/quickbooks/models/list_item.rb, line 12</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-constant">ListOrTxn</span>
+      <span class="ruby-value str">'List'</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Quickbooks/Model.html ADDED

@@ -0,0 +1,469 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Quickbooks::Model</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Quickbooks::Model</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/quickbooks/model_rb.html">
+                lib/quickbooks/model.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="../Object.html">
+                Object
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+These were all created from the info in qbxmlops70.xml, found in the docs
+in the QBSDK package.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000076">==</a>&nbsp;&nbsp;
+      <a href="#M000077">===</a>&nbsp;&nbsp;
+      <a href="#M000069">attributes</a>&nbsp;&nbsp;
+      <a href="#M000070">attributes=</a>&nbsp;&nbsp;
+      <a href="#M000064">camelized_valid_filters</a>&nbsp;&nbsp;
+      <a href="#M000072">dirty?</a>&nbsp;&nbsp;
+      <a href="#M000073">dirty_attributes</a>&nbsp;&nbsp;
+      <a href="#M000063">filter_aliases</a>&nbsp;&nbsp;
+      <a href="#M000062">filter_aliases=</a>&nbsp;&nbsp;
+      <a href="#M000059">inherited</a>&nbsp;&nbsp;
+      <a href="#M000068">new</a>&nbsp;&nbsp;
+      <a href="#M000071">original_values</a>&nbsp;&nbsp;
+      <a href="#M000067">properties</a>&nbsp;&nbsp;
+      <a href="#M000066">read_only</a>&nbsp;&nbsp;
+      <a href="#M000065">read_write</a>&nbsp;&nbsp;
+      <a href="#M000074">to_dirty_hash</a>&nbsp;&nbsp;
+      <a href="#M000075">to_hash</a>&nbsp;&nbsp;
+      <a href="#M000061">valid_filters</a>&nbsp;&nbsp;
+      <a href="#M000060">valid_filters=</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000064" class="method-detail">
+        <a name="M000064"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000064.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000064.html');return false;">
+          <span class="method-name">camelized_valid_filters</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000063" class="method-detail">
+        <a name="M000063"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000063.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000063.html');return false;">
+          <span class="method-name">filter_aliases</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000062" class="method-detail">
+        <a name="M000062"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000062.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000062.html');return false;">
+          <span class="method-name">filter_aliases=</span><span class="method-args">(v)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000059" class="method-detail">
+        <a name="M000059"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000059.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000059.html');return false;">
+          <span class="method-name">inherited</span><span class="method-args">(klass)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000068" class="method-detail">
+        <a name="M000068"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000068.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000068.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(args={})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+The default for all subclasses is simply to apply the <a
+href="Model.html#M000069">attributes</a> given, and mark the object as a
+new_record?
+</p>
+        </div>
+      </div>
+      <div id="method-M000067" class="method-detail">
+        <a name="M000067"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000067.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000067.html');return false;">
+          <span class="method-name">properties</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000066" class="method-detail">
+        <a name="M000066"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000066.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000066.html');return false;">
+          <span class="method-name">read_only</span><span class="method-args">(*args)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Read-only <a href="Model.html#M000069">attributes</a>: These are <a
+href="Model.html#M000069">attributes</a>, but not modifiable in <a
+href="../Quickbooks.html">Quickbooks</a>
+</p>
+        </div>
+      </div>
+      <div id="method-M000065" class="method-detail">
+        <a name="M000065"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000065.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000065.html');return false;">
+          <span class="method-name">read_write</span><span class="method-args">(*args)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Register multiple read/writable <a href="Model.html#M000067">properties</a>
+at once. For example:
+</p>
+<pre>
+  read_write :first_name, :last_name, :phone, :alt_phone
+</pre>
+<p>
+For reference <a href="Model.html#M000069">attributes</a> (like
+parent_ref), use <a href="ParentRef.html">ParentRef</a> - a class constant
+for that object. <em><a href="Model.html#M000065">read_write</a></em> will
+set the property setter and accessor accordingly.
+</p>
+        </div>
+      </div>
+      <div id="method-M000061" class="method-detail">
+        <a name="M000061"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000061.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000061.html');return false;">
+          <span class="method-name">valid_filters</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000060" class="method-detail">
+        <a name="M000060"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000060.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000060.html');return false;">
+          <span class="method-name">valid_filters=</span><span class="method-args">(v)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000076" class="method-detail">
+        <a name="M000076"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000076.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000076.html');return false;">
+          <span class="method-name">==</span><span class="method-args">(other)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000077" class="method-detail">
+        <a name="M000077"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000077.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000077.html');return false;">
+          <span class="method-name">===</span><span class="method-args">(other)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000069" class="method-detail">
+        <a name="M000069"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000069.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000069.html');return false;">
+          <span class="method-name">attributes</span><span class="method-args">(include_read_only=false)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns a hash that represents all this object&#8216;s <a
+href="Model.html#M000069">attributes</a>.
+</p>
+        </div>
+      </div>
+      <div id="method-M000070" class="method-detail">
+        <a name="M000070"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000070.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000070.html');return false;">
+          <span class="method-name">attributes=</span><span class="method-args">(attrs)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Updates all <a href="Model.html#M000069">attributes</a> included in
+<em>attrs</em> to the values given. The object will now be <a
+href="Model.html#M000072">dirty?</a>.
+</p>
+        </div>
+      </div>
+      <div id="method-M000072" class="method-detail">
+        <a name="M000072"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000072.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000072.html');return false;">
+          <span class="method-name">dirty?</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns true if any <a href="Model.html#M000069">attributes</a> have
+changed since the object was last loaded or updated from <a
+href="../Quickbooks.html">Quickbooks</a>.
+</p>
+        </div>
+      </div>
+      <div id="method-M000073" class="method-detail">
+        <a name="M000073"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000073.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000073.html');return false;">
+          <span class="method-name">dirty_attributes</span><span class="method-args">(compare={})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns a hash of the <a href="Model.html#M000069">attributes</a> and their
+(<a href="Model.html#M000068">new</a>) values that have been changed since
+the object was last loaded or updated from <a
+href="../Quickbooks.html">Quickbooks</a>. If you send in some <a
+href="Model.html#M000069">attributes</a>, it will compare to those given
+instead of original_attributes.
+</p>
+        </div>
+      </div>
+      <div id="method-M000071" class="method-detail">
+        <a name="M000071"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000071.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000071.html');return false;">
+          <span class="method-name">original_values</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Keeps track of the original values the object had when it was instantiated
+from a quickbooks response. <a href="Model.html#M000072">dirty?</a> and <a
+href="Model.html#M000073">dirty_attributes</a> compare the current values
+with these ones.
+</p>
+        </div>
+      </div>
+      <div id="method-M000074" class="method-detail">
+        <a name="M000074"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000074.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000074.html');return false;">
+          <span class="method-name">to_dirty_hash</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000075" class="method-detail">
+        <a name="M000075"></a>
+        <div class="method-heading">
+          <a href="Model.src/M000075.html" target="Code" class="method-signature"
+            onclick="popupCode('Model.src/M000075.html');return false;">
+          <span class="method-name">to_hash</span><span class="method-args">(include_read_only=false)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>