quickbooks 0.0.7 → 0.4.0

data/doc/classes/Quickbooks.html

@@ -166,6 +166,12 @@ Class <a href="Quickbooks/TxnDeleted.html" class="link">Quickbooks::TxnDeleted</
           <td class="context-item-name">CAMELIZE_EXCEPTIONS</td>
           <td>=</td>
           <td class="context-item-value">{'list_id' =&gt; 'ListID', 'txn_id' =&gt; 'TxnID', 'owner_id' =&gt; 'OwnerID'}</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+These were all created from the info in qbxmlops70.xml, found in the docs
+in the QBSDK package.
+
+</td>
         </tr>
         </table>
       </div>

data/doc/classes/Quickbooks/Address.html

@@ -88,7 +88,7 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000150">inherited</a>&nbsp;&nbsp;
+      <a href="#M000115">inherited</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -110,12 +110,12 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000150" class="method-detail">
-        <a name="M000150"></a>
+      <div id="method-M000115" class="method-detail">
+        <a name="M000115"></a>
 
         <div class="method-heading">
-          <a href="Address.src/M000150.html" target="Code" class="method-signature"
-            onclick="popupCode('Address.src/M000150.html');return false;">
+          <a href="Address.src/M000115.html" target="Code" class="method-signature"
+            onclick="popupCode('Address.src/M000115.html');return false;">
           <span class="method-name">inherited</span><span class="method-args">(klass)</span>
           </a>
         </div>

data/doc/classes/Quickbooks/Base.html

@@ -87,6 +87,41 @@ href="ListItem.html">ListItem</a> and <a
 href="Transaction.html">Transaction</a>. It inherits from <a
 href="Model.html">Model</a>, just as <a href="Ref.html">Ref</a> does.
 </p>
+<p>
+Some <a href="../Qbxml.html">Qbxml</a> specifications require certain
+finder-options to be placed inside a containing entity, such as:
+</p>
+<pre>
+  ...
+  &lt;DeletedDateRangeFilter&gt;
+    &lt;FromDeletedDate&gt;#{(Time.now - 5*60*60).xmlschema}&lt;/FromDeletedDate&gt;
+    &lt;ToDeletedDate&gt;#{(Time.now - 3*60*60).xmlschema}&lt;/ToDeletedDate&gt;
+  &lt;/DeletedDateRangeFilter&gt;
+  ...
+</pre>
+<p>
+The <a href="../Quickbooks.html">Quickbooks</a> Models define aliases to
+these &quot;inside&quot; options. The equivalent to the above [partial] <a
+href="Base.html#M000101">request</a>:
+</p>
+<pre>
+  Quickbooks::Deleted.all(:deleted_after =&gt; (Time.now - 5*60*60).xmlschema, :deleted_before =&gt; (Time.now - 3*60*60).xmlschema)
+</pre>
+<p>
+(Type-casting hasn&#8216;t made it in yet.)
+</p>
+<p>
+<a href="../Qbxml.html">Qbxml</a> makes a special allowance for <a
+href="Deleted.html">Deleted</a> items. Much of the time, we&#8216;d rather
+access a model&#8216;s <a href="Base.html#M000105">deleted</a> items
+through that model class instead of through the <a
+href="Base.html#M000105">deleted</a> class. So <a
+href="../Qbxml.html">Qbxml</a> allows any class to ask for its <a
+href="Base.html#M000105">deleted</a> items through a call like this:
+</p>
+<pre>
+  Quickbooks::Customer.deleted(:deleted_after =&gt; Time.now - 3*60*60)
+</pre>
 
     </div>
 
@@ -97,23 +132,24 @@ href="Model.html">Model</a>, just as <a href="Ref.html">Ref</a> does.
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000147">==</a>&nbsp;&nbsp;
-      <a href="#M000139">all</a>&nbsp;&nbsp;
-      <a href="#M000134">connection</a>&nbsp;&nbsp;
-      <a href="#M000135">connection=</a>&nbsp;&nbsp;
-      <a href="#M000141">create</a>&nbsp;&nbsp;
-      <a href="#M000146">destroy</a>&nbsp;&nbsp;
-      <a href="#M000133">establish_connection</a>&nbsp;&nbsp;
-      <a href="#M000140">first</a>&nbsp;&nbsp;
-      <a href="#M000138">instantiate</a>&nbsp;&nbsp;
-      <a href="#M000142">new</a>&nbsp;&nbsp;
-      <a href="#M000143">new_record?</a>&nbsp;&nbsp;
-      <a href="#M000136">query</a>&nbsp;&nbsp;
-      <a href="#M000145">reload</a>&nbsp;&nbsp;
-      <a href="#M000137">request</a>&nbsp;&nbsp;
-      <a href="#M000144">save</a>&nbsp;&nbsp;
-      <a href="#M000131">success?</a>&nbsp;&nbsp;
-      <a href="#M000132">use_adapter</a>&nbsp;&nbsp;
+      <a href="#M000112">==</a>&nbsp;&nbsp;
+      <a href="#M000103">all</a>&nbsp;&nbsp;
+      <a href="#M000098">connection</a>&nbsp;&nbsp;
+      <a href="#M000099">connection=</a>&nbsp;&nbsp;
+      <a href="#M000106">create</a>&nbsp;&nbsp;
+      <a href="#M000105">deleted</a>&nbsp;&nbsp;
+      <a href="#M000111">destroy</a>&nbsp;&nbsp;
+      <a href="#M000097">establish_connection</a>&nbsp;&nbsp;
+      <a href="#M000104">first</a>&nbsp;&nbsp;
+      <a href="#M000102">instantiate</a>&nbsp;&nbsp;
+      <a href="#M000107">new</a>&nbsp;&nbsp;
+      <a href="#M000108">new_record?</a>&nbsp;&nbsp;
+      <a href="#M000100">query</a>&nbsp;&nbsp;
+      <a href="#M000110">reload</a>&nbsp;&nbsp;
+      <a href="#M000101">request</a>&nbsp;&nbsp;
+      <a href="#M000109">save</a>&nbsp;&nbsp;
+      <a href="#M000095">success?</a>&nbsp;&nbsp;
+      <a href="#M000096">use_adapter</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -152,12 +188,12 @@ objects that were a result of methods performed on this object.
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000139" class="method-detail">
-        <a name="M000139"></a>
+      <div id="method-M000103" class="method-detail">
+        <a name="M000103"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000139.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000139.html');return false;">
+          <a href="Base.src/M000103.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000103.html');return false;">
           <span class="method-name">all</span><span class="method-args">(filters={})</span>
           </a>
         </div>
@@ -165,20 +201,20 @@ objects that were a result of methods performed on this object.
         <div class="method-description">
           <p>
 Queries <a href="../Quickbooks.html">Quickbooks</a> for <a
-href="Base.html#M000139">all</a> of the objects of the current
+href="Base.html#M000103">all</a> of the objects of the current
 class&#8216;s type. For example, Quickbooks::Customer.all will return an
 array of <a href="Customer.html">Quickbooks::Customer</a> objects
-representing <a href="Base.html#M000139">all</a> customers.
+representing <a href="Base.html#M000103">all</a> customers.
 </p>
         </div>
       </div>
 
-      <div id="method-M000134" class="method-detail">
-        <a name="M000134"></a>
+      <div id="method-M000098" class="method-detail">
+        <a name="M000098"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000134.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000134.html');return false;">
+          <a href="Base.src/M000098.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000098.html');return false;">
           <span class="method-name">connection</span><span class="method-args">()</span>
           </a>
         </div>
@@ -190,12 +226,12 @@ Returns the current Connection
         </div>
       </div>
 
-      <div id="method-M000135" class="method-detail">
-        <a name="M000135"></a>
+      <div id="method-M000099" class="method-detail">
+        <a name="M000099"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000135.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000135.html');return false;">
+          <a href="Base.src/M000099.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000099.html');return false;">
           <span class="method-name">connection=</span><span class="method-args">(conn)</span>
           </a>
         </div>
@@ -206,9 +242,9 @@ Sets the current Connection.
 </p>
 <p>
 This is normally not needed, but in the case that you may want to connect a
-separate <a href="Base.html#M000134">connection</a> to <a
+separate <a href="Base.html#M000098">connection</a> to <a
 href="../Quickbooks.html">Quickbooks</a>, you can use this method to
-explicitly set the <a href="Base.html#M000134">connection</a> in a class
+explicitly set the <a href="Base.html#M000098">connection</a> in a class
 that inherits from <a href="Base.html">Quickbooks::Base</a>.
 </p>
 <pre>
@@ -217,51 +253,71 @@ that inherits from <a href="Base.html">Quickbooks::Base</a>.
         </div>
       </div>
 
-      <div id="method-M000141" class="method-detail">
-        <a name="M000141"></a>
+      <div id="method-M000106" class="method-detail">
+        <a name="M000106"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000141.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000141.html');return false;">
+          <a href="Base.src/M000106.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000106.html');return false;">
           <span class="method-name">create</span><span class="method-args">(*args)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Creates a <a href="Base.html#M000142">new</a> object of the current
+Creates a <a href="Base.html#M000107">new</a> object of the current
 class&#8216;s type. For example, Quickbooks::Customer.create(:name =&gt;
-&#8216;Tommy&#8217;) will <a href="Base.html#M000141">create</a> a customer
+&#8216;Tommy&#8217;) will <a href="Base.html#M000106">create</a> a customer
 object with a Name of Tommy.
 </p>
         </div>
       </div>
 
-      <div id="method-M000133" class="method-detail">
-        <a name="M000133"></a>
+      <div id="method-M000105" class="method-detail">
+        <a name="M000105"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000133.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000133.html');return false;">
+          <a href="Base.src/M000105.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000105.html');return false;">
+          <span class="method-name">deleted</span><span class="method-args">(filters={})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Still in testing&#8230; these should be equivalent:
+</p>
+<pre>
+  Quickbooks::Customer.deleted(:deleted_before =&gt; Time.now) == Quickbooks::Deleted.all(:type =&gt; 'Customer', :deleted_before =&gt; Time.now)
+</pre>
+        </div>
+      </div>
+
+      <div id="method-M000097" class="method-detail">
+        <a name="M000097"></a>
+
+        <div class="method-heading">
+          <a href="Base.src/M000097.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000097.html');return false;">
           <span class="method-name">establish_connection</span><span class="method-args">(*args)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Establishes a <a href="Base.html#M000134">connection</a> to the <a
+Establishes a <a href="Base.html#M000098">connection</a> to the <a
 href="../Quickbooks.html">Quickbooks</a> RDS Server for <a
-href="Base.html#M000139">all</a> <a href="Model.html">Model</a> Classes
+href="Base.html#M000103">all</a> <a href="Model.html">Model</a> Classes
 </p>
         </div>
       </div>
 
-      <div id="method-M000140" class="method-detail">
-        <a name="M000140"></a>
+      <div id="method-M000104" class="method-detail">
+        <a name="M000104"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000140.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000140.html');return false;">
+          <a href="Base.src/M000104.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000104.html');return false;">
           <span class="method-name">first</span><span class="method-args">(filters={})</span>
           </a>
         </div>
@@ -269,61 +325,66 @@ href="Base.html#M000139">all</a> <a href="Model.html">Model</a> Classes
         <div class="method-description">
           <p>
 Queries <a href="../Quickbooks.html">Quickbooks</a> for the <a
-href="Base.html#M000140">first</a> object of the current class&#8216;s
+href="Base.html#M000104">first</a> object of the current class&#8216;s
 type. For example, Quickbooks::Customer.first will return a <a
 href="Customer.html">Quickbooks::Customer</a> object representing the <a
-href="Base.html#M000140">first</a> customer.
+href="Base.html#M000104">first</a> customer.
 </p>
         </div>
       </div>
 
-      <div id="method-M000138" class="method-detail">
-        <a name="M000138"></a>
+      <div id="method-M000102" class="method-detail">
+        <a name="M000102"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000138.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000138.html');return false;">
+          <a href="Base.src/M000102.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000102.html');return false;">
           <span class="method-name">instantiate</span><span class="method-args">(obj_or_attrs={},attrs={})</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Instantiate a <a href="Base.html#M000142">new</a> object with just
+Instantiate a <a href="Base.html#M000107">new</a> object with just
 attributes, or an existing object replacing the attributes
 </p>
         </div>
       </div>
 
-      <div id="method-M000142" class="method-detail">
-        <a name="M000142"></a>
+      <div id="method-M000107" class="method-detail">
+        <a name="M000107"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000142.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000142.html');return false;">
+          <a href="Base.src/M000107.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000107.html');return false;">
           <span class="method-name">new</span><span class="method-args">(*args)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+Generates a <a href="Base.html#M000107">new</a> object that can be saved
+into <a href="../Quickbooks.html">Quickbooks</a> once the required
+attributes are set.
+</p>
         </div>
       </div>
 
-      <div id="method-M000136" class="method-detail">
-        <a name="M000136"></a>
+      <div id="method-M000100" class="method-detail">
+        <a name="M000100"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000136.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000136.html');return false;">
+          <a href="Base.src/M000100.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000100.html');return false;">
           <span class="method-name">query</span><span class="method-args">(obj_or_args,*args)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Generates a <a href="Base.html#M000137">request</a> by sending *args to
-Qbxml::Request.new, sends the <a href="Base.html#M000137">request</a> over
-the current <a href="Base.html#M000134">connection</a>, and interprets the
+Generates a <a href="Base.html#M000101">request</a> by sending *args to
+Qbxml::Request.new, sends the <a href="Base.html#M000101">request</a> over
+the current <a href="Base.html#M000098">connection</a>, and interprets the
 response using <a href="../Qbxml/ResponseSet.html">Qbxml::ResponseSet</a>.
 The response is then instantiated into an object or an array of objects.
 </p>
@@ -334,19 +395,19 @@ use it to perform custom requests.
         </div>
       </div>
 
-      <div id="method-M000137" class="method-detail">
-        <a name="M000137"></a>
+      <div id="method-M000101" class="method-detail">
+        <a name="M000101"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000137.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000137.html');return false;">
+          <a href="Base.src/M000101.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000101.html');return false;">
           <span class="method-name">request</span><span class="method-args">(*args)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Generates a <a href="Base.html#M000137">request</a> using <a
+Generates a <a href="Base.html#M000101">request</a> using <a
 href="../Qbxml/Request.html">Qbxml::Request</a>, sends it, and returns a <a
 href="../Qbxml/ResponseSet.html">Qbxml::ResponseSet</a> object containing
 the response(s).
@@ -354,12 +415,12 @@ the response(s).
         </div>
       </div>
 
-      <div id="method-M000132" class="method-detail">
-        <a name="M000132"></a>
+      <div id="method-M000096" class="method-detail">
+        <a name="M000096"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000132.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000132.html');return false;">
+          <a href="Base.src/M000096.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000096.html');return false;">
           <span class="method-name">use_adapter</span><span class="method-args">(adapter)</span>
           </a>
         </div>
@@ -370,12 +431,12 @@ the response(s).
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000147" class="method-detail">
-        <a name="M000147"></a>
+      <div id="method-M000112" class="method-detail">
+        <a name="M000112"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000147.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000147.html');return false;">
+          <a href="Base.src/M000112.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000112.html');return false;">
           <span class="method-name">==</span><span class="method-args">(other)</span>
           </a>
         </div>
@@ -383,17 +444,17 @@ the response(s).
         <div class="method-description">
           <p>
 Usual comparison (super), but add in false if either is a <a
-href="Base.html#M000142">new</a> record.
+href="Base.html#M000107">new</a> record.
 </p>
         </div>
       </div>
 
-      <div id="method-M000146" class="method-detail">
-        <a name="M000146"></a>
+      <div id="method-M000111" class="method-detail">
+        <a name="M000111"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000146.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000146.html');return false;">
+          <a href="Base.src/M000111.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000111.html');return false;">
           <span class="method-name">destroy</span><span class="method-args">()</span>
           </a>
         </div>
@@ -402,39 +463,39 @@ href="Base.html#M000142">new</a> record.
           <p>
 Destroys a record in <a href="../Quickbooks.html">Quickbooks</a>. Note that
 even though <a href="../Quickbooks.html">Quickbooks</a> will <a
-href="Base.html#M000146">destroy</a> the record, the record&#8216;s ListID
+href="Base.html#M000111">destroy</a> the record, the record&#8216;s ListID
 and DeletedTime can be accessed by doing a <a
-href="Base.html#M000136">query</a> for deleted objects of the appropriate
-type.
+href="Base.html#M000100">query</a> for <a
+href="Base.html#M000105">deleted</a> objects of the appropriate type.
 </p>
         </div>
       </div>
 
-      <div id="method-M000143" class="method-detail">
-        <a name="M000143"></a>
+      <div id="method-M000108" class="method-detail">
+        <a name="M000108"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000143.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000143.html');return false;">
+          <a href="Base.src/M000108.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000108.html');return false;">
           <span class="method-name">new_record?</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Returns true if the object is a <a href="Base.html#M000142">new</a> object
+Returns true if the object is a <a href="Base.html#M000107">new</a> object
 (that doesn&#8216;t represent an existing object in <a
 href="../Quickbooks.html">Quickbooks</a>).
 </p>
         </div>
       </div>
 
-      <div id="method-M000145" class="method-detail">
-        <a name="M000145"></a>
+      <div id="method-M000110" class="method-detail">
+        <a name="M000110"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000145.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000145.html');return false;">
+          <a href="Base.src/M000110.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000110.html');return false;">
           <span class="method-name">reload</span><span class="method-args">()</span>
           </a>
         </div>
@@ -447,12 +508,12 @@ discarding any changes that have been made to it.
         </div>
       </div>
 
-      <div id="method-M000144" class="method-detail">
-        <a name="M000144"></a>
+      <div id="method-M000109" class="method-detail">
+        <a name="M000109"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000144.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000144.html');return false;">
+          <a href="Base.src/M000109.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000109.html');return false;">
           <span class="method-name">save</span><span class="method-args">()</span>
           </a>
         </div>
@@ -468,17 +529,17 @@ there are conflicts, the updated values from <a
 href="../Quickbooks.html">Quickbooks</a> will be written to the
 original_values, and false is returned. This way you can deal with the
 differences (conflicts), if you so desire, and simply call <a
-href="Base.html#M000144">save</a> again to commit your changes.
+href="Base.html#M000109">save</a> again to commit your changes.
 </p>
         </div>
       </div>
 
-      <div id="method-M000131" class="method-detail">
-        <a name="M000131"></a>
+      <div id="method-M000095" class="method-detail">
+        <a name="M000095"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000131.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000131.html');return false;">
+          <a href="Base.src/M000095.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000095.html');return false;">
           <span class="method-name">success?</span><span class="method-args">()</span>
           </a>
         </div>