quickbooks 0.0.2 → 0.0.3

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 (135) hide show
  1. data/README +18 -28
  2. data/Rakefile +17 -30
  3. data/doc/classes/{QuickBooks/Models/DataExt.html → Class.html} +151 -140
  4. data/doc/classes/Class.src/M000003.html +18 -0
  5. data/doc/classes/Hash.html +164 -0
  6. data/doc/classes/Hash.src/M000001.html +20 -0
  7. data/doc/classes/Hash.src/M000002.html +23 -0
  8. data/doc/classes/{QuickBooks/Models/Transaction.html → Object.html} +207 -201
  9. data/doc/classes/Object.src/M000004.html +24 -0
  10. data/doc/classes/Object.src/M000005.html +18 -0
  11. data/doc/classes/Object.src/M000006.html +19 -0
  12. data/doc/classes/Object.src/M000007.html +18 -0
  13. data/doc/classes/{QuickBooks.html → QBHelpers.html} +118 -119
  14. data/doc/classes/QBHelpers/Ole.html +209 -0
  15. data/doc/classes/QBHelpers/Ole.src/M000066.html +21 -0
  16. data/doc/classes/QBHelpers/Ole.src/M000067.html +22 -0
  17. data/doc/classes/QBHelpers/Ole.src/M000068.html +18 -0
  18. data/doc/classes/Quickbooks.html +136 -0
  19. data/doc/classes/Quickbooks/Base.html +618 -0
  20. data/doc/classes/Quickbooks/Base.src/M000034.html +18 -0
  21. data/doc/classes/Quickbooks/Base.src/M000035.html +18 -0
  22. data/doc/classes/Quickbooks/Base.src/M000036.html +18 -0
  23. data/doc/classes/Quickbooks/Base.src/M000037.html +19 -0
  24. data/doc/classes/Quickbooks/Base.src/M000038.html +19 -0
  25. data/doc/classes/Quickbooks/Base.src/M000039.html +25 -0
  26. data/doc/classes/Quickbooks/Base.src/M000040.html +27 -0
  27. data/doc/classes/Quickbooks/Base.src/M000041.html +22 -0
  28. data/doc/classes/Quickbooks/Base.src/M000042.html +30 -0
  29. data/doc/classes/Quickbooks/Base.src/M000043.html +18 -0
  30. data/doc/classes/Quickbooks/Base.src/M000044.html +19 -0
  31. data/doc/classes/Quickbooks/Base.src/M000045.html +18 -0
  32. data/doc/classes/Quickbooks/Base.src/M000046.html +19 -0
  33. data/doc/classes/Quickbooks/Base.src/M000047.html +22 -0
  34. data/doc/classes/Quickbooks/Base.src/M000048.html +23 -0
  35. data/doc/classes/Quickbooks/Base.src/M000049.html +18 -0
  36. data/doc/classes/Quickbooks/Base.src/M000050.html +21 -0
  37. data/doc/classes/Quickbooks/Base.src/M000051.html +25 -0
  38. data/doc/classes/Quickbooks/Base.src/M000052.html +18 -0
  39. data/doc/classes/Quickbooks/Base.src/M000053.html +36 -0
  40. data/doc/classes/Quickbooks/Base.src/M000054.html +18 -0
  41. data/doc/classes/Quickbooks/Base.src/M000055.html +18 -0
  42. data/doc/classes/Quickbooks/Connection.html +369 -0
  43. data/doc/classes/{QuickBooks/Models/Customer.src/M000002.html → Quickbooks/Connection.src/M000056.html} +17 -17
  44. data/doc/classes/Quickbooks/Connection.src/M000057.html +19 -0
  45. data/doc/classes/Quickbooks/Connection.src/M000058.html +25 -0
  46. data/doc/classes/{QuickBooks/Connection.src/M000018.html → Quickbooks/Connection.src/M000059.html} +17 -17
  47. data/doc/classes/Quickbooks/Connection.src/M000060.html +18 -0
  48. data/doc/classes/Quickbooks/Connection.src/M000061.html +21 -0
  49. data/doc/classes/Quickbooks/Connection.src/M000062.html +24 -0
  50. data/doc/classes/{QuickBooks/Connection.src/M000016.html → Quickbooks/Connection.src/M000063.html} +19 -20
  51. data/doc/classes/{QuickBooks/Connection.src/M000019.html → Quickbooks/Connection.src/M000064.html} +23 -21
  52. data/doc/classes/Quickbooks/Connection.src/M000065.html +24 -0
  53. data/doc/classes/{QuickBooks/Models.html → Quickbooks/Customer.html} +112 -120
  54. data/doc/classes/{QuickBooks/Models/CreditCardInfo.html → Quickbooks/ListItem.html} +176 -148
  55. data/doc/classes/Quickbooks/ListItem.src/M000033.html +31 -0
  56. data/doc/classes/Quickbooks/Qbxml.html +138 -0
  57. data/doc/classes/{QuickBooks/Models/ListItem.html → Quickbooks/Qbxml/Error.html} +167 -173
  58. data/doc/classes/{QuickBooks/Models/Base.src/M000011.html → Quickbooks/Qbxml/Error.src/M000031.html} +17 -17
  59. data/doc/classes/Quickbooks/Qbxml/Request.html +182 -0
  60. data/doc/classes/Quickbooks/Qbxml/Request.src/M000024.html +23 -0
  61. data/doc/classes/Quickbooks/Qbxml/Request.src/M000025.html +19 -0
  62. data/doc/classes/Quickbooks/Qbxml/Request.src/M000026.html +57 -0
  63. data/doc/classes/Quickbooks/Qbxml/RequestSet.html +193 -0
  64. data/doc/classes/Quickbooks/Qbxml/RequestSet.src/M000027.html +22 -0
  65. data/doc/classes/Quickbooks/Qbxml/RequestSet.src/M000028.html +26 -0
  66. data/doc/classes/{QuickBooks/Models/Base.src/M000014.html → Quickbooks/Qbxml/RequestSet.src/M000029.html} +17 -16
  67. data/doc/classes/Quickbooks/Qbxml/RequestSet.src/M000030.html +22 -0
  68. data/doc/classes/Quickbooks/Qbxml/RequestSetArrayExt.html +105 -0
  69. data/doc/classes/{QuickBooks/Connection.html → Quickbooks/Qbxml/Response.html} +301 -278
  70. data/doc/classes/Quickbooks/Qbxml/Response.src/M000015.html +24 -0
  71. data/doc/classes/Quickbooks/Qbxml/Response.src/M000016.html +19 -0
  72. data/doc/classes/Quickbooks/Qbxml/Response.src/M000017.html +45 -0
  73. data/doc/classes/Quickbooks/Qbxml/Response.src/M000018.html +18 -0
  74. data/doc/classes/Quickbooks/Qbxml/Response.src/M000019.html +18 -0
  75. data/doc/classes/Quickbooks/Qbxml/Response.src/M000020.html +18 -0
  76. data/doc/classes/{QuickBooks/Models/Base.src/M000013.html → Quickbooks/Qbxml/Response.src/M000021.html} +17 -16
  77. data/doc/classes/{QuickBooks/Models/ListItem.src/M000009.html → Quickbooks/Qbxml/Response.src/M000022.html} +17 -16
  78. data/doc/classes/Quickbooks/Qbxml/Response.src/M000023.html +52 -0
  79. data/doc/classes/{QuickBooks/Models/Base.html → Quickbooks/Qbxml/ResponseSet.html} +237 -213
  80. data/doc/classes/Quickbooks/Qbxml/ResponseSet.src/M000008.html +22 -0
  81. data/doc/classes/Quickbooks/Qbxml/ResponseSet.src/M000009.html +26 -0
  82. data/doc/classes/Quickbooks/Qbxml/ResponseSet.src/M000010.html +24 -0
  83. data/doc/classes/{QuickBooks/Models/Base.src/M000012.html → Quickbooks/Qbxml/ResponseSet.src/M000011.html} +17 -17
  84. data/doc/classes/Quickbooks/Qbxml/ResponseSet.src/M000012.html +27 -0
  85. data/doc/classes/Quickbooks/Qbxml/ResponseSet.src/M000013.html +18 -0
  86. data/doc/classes/Quickbooks/Qbxml/ResponseSet.src/M000014.html +18 -0
  87. data/doc/classes/Quickbooks/Qbxml/ResponseSetArrayExt.html +105 -0
  88. data/doc/classes/{QuickBooks/Models/Address.html → Quickbooks/Transaction.html} +194 -158
  89. data/doc/classes/Quickbooks/Transaction.src/M000032.html +26 -0
  90. data/doc/created.rid +1 -1
  91. data/doc/files/LICENSE.html +128 -128
  92. data/doc/files/README.html +185 -173
  93. data/doc/files/lib/quickbooks/base_rb.html +317 -0
  94. data/doc/files/lib/quickbooks/connection_rb.html +108 -108
  95. data/doc/files/lib/quickbooks/models/{base_rb.html → customer_rb.html} +100 -100
  96. data/doc/files/lib/quickbooks/models/list_item_rb.html +101 -0
  97. data/doc/files/lib/quickbooks/models/transaction_rb.html +101 -0
  98. data/doc/files/lib/quickbooks/ole_helper_rb.html +109 -0
  99. data/doc/files/lib/quickbooks/qbxml/error_rb.html +101 -0
  100. data/doc/files/lib/quickbooks/{models/models_rb.html → qbxml/request_rb.html} +108 -107
  101. data/doc/files/lib/quickbooks/qbxml/response_rb.html +109 -0
  102. data/doc/files/lib/quickbooks/ruby_magic_rb.html +111 -0
  103. data/doc/files/lib/quickbooks_rb.html +112 -108
  104. data/doc/fr_class_index.html +44 -35
  105. data/doc/fr_file_index.html +38 -31
  106. data/doc/fr_method_index.html +93 -44
  107. data/doc/index.html +23 -23
  108. data/doc/rdoc-style.css +207 -207
  109. data/lib/quickbooks.rb +6 -1
  110. data/lib/quickbooks/base.rb +282 -0
  111. data/lib/quickbooks/connection.rb +91 -57
  112. data/lib/quickbooks/models/customer.rb +71 -0
  113. data/lib/quickbooks/models/list_item.rb +22 -0
  114. data/lib/quickbooks/models/transaction.rb +40 -0
  115. data/lib/quickbooks/ole_helper.rb +47 -0
  116. data/lib/quickbooks/qbxml/error.rb +20 -0
  117. data/lib/quickbooks/qbxml/request.rb +120 -0
  118. data/lib/quickbooks/qbxml/response.rb +176 -0
  119. data/lib/quickbooks/ruby_magic.rb +67 -0
  120. metadata +173 -84
  121. data/doc/classes/QuickBooks/Connection.src/M000015.html +0 -25
  122. data/doc/classes/QuickBooks/Connection.src/M000017.html +0 -20
  123. data/doc/classes/QuickBooks/Models/Base.src/M000010.html +0 -19
  124. data/doc/classes/QuickBooks/Models/Customer.html +0 -424
  125. data/doc/classes/QuickBooks/Models/Customer.src/M000001.html +0 -34
  126. data/doc/classes/QuickBooks/Models/Customer.src/M000003.html +0 -18
  127. data/doc/classes/QuickBooks/Models/ListItem.src/M000008.html +0 -17
  128. data/doc/classes/QuickBooks/Models/Transaction.src/M000004.html +0 -17
  129. data/doc/classes/QuickBooks/Models/Transaction.src/M000005.html +0 -17
  130. data/doc/classes/QuickBooks/Models/Transaction.src/M000006.html +0 -17
  131. data/doc/classes/QuickBooks/Models/Transaction.src/M000007.html +0 -17
  132. data/lib/quickbooks/models/base.rb +0 -72
  133. data/lib/quickbooks/models/models.rb +0 -43
  134. data/test/quickbooks/quickbooks_test.rb +0 -34
  135. data/test/test_helper.rb +0 -4
data/doc/classes/QBHelpers/Ole.src/M000066.html ADDED
@@ -0,0 +1,21 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>new (QBHelpers::Ole)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/quickbooks/ole_helper.rb, line 9</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">ole_app</span>, <span class="ruby-identifier">type_library</span>=<span class="ruby-keyword kw">nil</span>)
15
+ <span class="ruby-ivar">@ole_app</span> = <span class="ruby-identifier">ole_app</span>
16
+ <span class="ruby-ivar">@type_library</span> = <span class="ruby-identifier">type_library</span>
17
+ <span class="ruby-ivar">@ole</span> = <span class="ruby-constant">WIN32OLE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ole_app</span>)
18
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">classes</span>
19
+ <span class="ruby-keyword kw">end</span></pre>
20
+ </body>
21
+ </html>
data/doc/classes/QBHelpers/Ole.src/M000067.html ADDED
@@ -0,0 +1,22 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>get_variable (QBHelpers::Ole)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/quickbooks/ole_helper.rb, line 23</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_variable</span>(<span class="ruby-identifier">var_name</span>)
15
+ <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@type_library</span>
16
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">classes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">class_name</span><span class="ruby-operator">|</span>
17
+ <span class="ruby-identifier">found</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">constant_for</span>(<span class="ruby-identifier">class_name</span>.<span class="ruby-identifier">name</span>).<span class="ruby-identifier">variables</span>.<span class="ruby-identifier">find</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">var</span><span class="ruby-operator">|</span> <span class="ruby-identifier">var</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">var_name</span>}
18
+ <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">found</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">found</span>
19
+ <span class="ruby-keyword kw">end</span>
20
+ <span class="ruby-keyword kw">end</span></pre>
21
+ </body>
22
+ </html>
data/doc/classes/QBHelpers/Ole.src/M000068.html ADDED
@@ -0,0 +1,18 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>method_missing (QBHelpers::Ole)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/quickbooks/ole_helper.rb, line 43</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
15
+ <span class="ruby-ivar">@ole</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
16
+ <span class="ruby-keyword kw">end</span></pre>
17
+ </body>
18
+ </html>
data/doc/classes/Quickbooks.html ADDED
@@ -0,0 +1,136 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Module: Quickbooks</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Module</strong></td>
53
+ <td class="class-name-in-header">Quickbooks</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../files/lib/quickbooks/base_rb.html">
59
+ lib/quickbooks/base.rb
60
+ </a>
61
+ <br />
62
+ <a href="../files/lib/quickbooks/connection_rb.html">
63
+ lib/quickbooks/connection.rb
64
+ </a>
65
+ <br />
66
+ <a href="../files/lib/quickbooks/models/customer_rb.html">
67
+ lib/quickbooks/models/customer.rb
68
+ </a>
69
+ <br />
70
+ <a href="../files/lib/quickbooks/qbxml/error_rb.html">
71
+ lib/quickbooks/qbxml/error.rb
72
+ </a>
73
+ <br />
74
+ <a href="../files/lib/quickbooks/qbxml/request_rb.html">
75
+ lib/quickbooks/qbxml/request.rb
76
+ </a>
77
+ <br />
78
+ <a href="../files/lib/quickbooks/qbxml/response_rb.html">
79
+ lib/quickbooks/qbxml/response.rb
80
+ </a>
81
+ <br />
82
+ </td>
83
+ </tr>
84
+
85
+ </table>
86
+ </div>
87
+ <!-- banner header -->
88
+
89
+ <div id="bodyContent">
90
+
91
+
92
+
93
+ <div id="contextContent">
94
+
95
+
96
+
97
+ </div>
98
+
99
+
100
+ </div>
101
+
102
+
103
+ <!-- if includes -->
104
+
105
+ <div id="section">
106
+
107
+ <div id="class-list">
108
+ <h3 class="section-bar">Classes and Modules</h3>
109
+
110
+ Module <a href="Quickbooks/Qbxml.html" class="link">Quickbooks::Qbxml</a><br />
111
+ Class <a href="Quickbooks/Base.html" class="link">Quickbooks::Base</a><br />
112
+ Class <a href="Quickbooks/Connection.html" class="link">Quickbooks::Connection</a><br />
113
+ Class <a href="Quickbooks/Customer.html" class="link">Quickbooks::Customer</a><br />
114
+ Class <a href="Quickbooks/ListItem.html" class="link">Quickbooks::ListItem</a><br />
115
+ Class <a href="Quickbooks/Transaction.html" class="link">Quickbooks::Transaction</a><br />
116
+
117
+ </div>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+ <!-- if method_list -->
126
+
127
+
128
+ </div>
129
+
130
+
131
+ <div id="validator-badges">
132
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
133
+ </div>
134
+
135
+ </body>
136
+ </html>
data/doc/classes/Quickbooks/Base.html ADDED
@@ -0,0 +1,618 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: Quickbooks::Base</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">Quickbooks::Base</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../files/lib/quickbooks/base_rb.html">
59
+ lib/quickbooks/base.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ <a href="../Object.html">
69
+ Object
70
+ </a>
71
+ </td>
72
+ </tr>
73
+ </table>
74
+ </div>
75
+ <!-- banner header -->
76
+
77
+ <div id="bodyContent">
78
+
79
+
80
+
81
+ <div id="contextContent">
82
+
83
+
84
+
85
+ </div>
86
+
87
+ <div id="method-list">
88
+ <h3 class="section-bar">Methods</h3>
89
+
90
+ <div class="name-list">
91
+ <a href="#M000043">all</a>&nbsp;&nbsp;
92
+ <a href="#M000047">attributes</a>&nbsp;&nbsp;
93
+ <a href="#M000048">attributes=</a>&nbsp;&nbsp;
94
+ <a href="#M000036">connection</a>&nbsp;&nbsp;
95
+ <a href="#M000037">connection=</a>&nbsp;&nbsp;
96
+ <a href="#M000045">create</a>&nbsp;&nbsp;
97
+ <a href="#M000055">destroy</a>&nbsp;&nbsp;
98
+ <a href="#M000050">dirty?</a>&nbsp;&nbsp;
99
+ <a href="#M000051">dirty_attributes</a>&nbsp;&nbsp;
100
+ <a href="#M000035">establish_connection</a>&nbsp;&nbsp;
101
+ <a href="#M000044">first</a>&nbsp;&nbsp;
102
+ <a href="#M000042">instantiate</a>&nbsp;&nbsp;
103
+ <a href="#M000046">new</a>&nbsp;&nbsp;
104
+ <a href="#M000052">new_record?</a>&nbsp;&nbsp;
105
+ <a href="#M000049">original_values</a>&nbsp;&nbsp;
106
+ <a href="#M000039">properties</a>&nbsp;&nbsp;
107
+ <a href="#M000038">property</a>&nbsp;&nbsp;
108
+ <a href="#M000054">reload</a>&nbsp;&nbsp;
109
+ <a href="#M000041">request</a>&nbsp;&nbsp;
110
+ <a href="#M000040">request_and_instantiate</a>&nbsp;&nbsp;
111
+ <a href="#M000053">save</a>&nbsp;&nbsp;
112
+ <a href="#M000034">success?</a>&nbsp;&nbsp;
113
+ </div>
114
+ </div>
115
+
116
+ </div>
117
+
118
+
119
+ <!-- if includes -->
120
+
121
+ <div id="section">
122
+
123
+
124
+
125
+
126
+
127
+ <div id="attribute-list">
128
+ <h3 class="section-bar">Attributes</h3>
129
+
130
+ <div class="name-list">
131
+ <table>
132
+ <tr class="top-aligned-row context-row">
133
+ <td class="context-item-name">response_log</td>
134
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
135
+ <td class="context-item-desc">
136
+ Stores a log of <a
137
+ href="Qbxml/Response.html">Quickbooks::Qbxml::Response</a> objects that
138
+ were a result of methods performed on this object.
139
+
140
+ </td>
141
+ </tr>
142
+ </table>
143
+ </div>
144
+ </div>
145
+
146
+
147
+
148
+ <!-- if method_list -->
149
+ <div id="methods">
150
+ <h3 class="section-bar">Public Class methods</h3>
151
+
152
+ <div id="method-M000043" class="method-detail">
153
+ <a name="M000043"></a>
154
+
155
+ <div class="method-heading">
156
+ <a href="Base.src/M000043.html" target="Code" class="method-signature"
157
+ onclick="popupCode('Base.src/M000043.html');return false;">
158
+ <span class="method-name">all</span><span class="method-args">(filters={})</span>
159
+ </a>
160
+ </div>
161
+
162
+ <div class="method-description">
163
+ <p>
164
+ Queries <a href="../Quickbooks.html">Quickbooks</a> for <a
165
+ href="Base.html#M000043">all</a> of the objects of the current
166
+ class&#8216;s type. For example, Quickbooks::Customer.all will return an
167
+ array of <a href="Customer.html">Quickbooks::Customer</a> objects
168
+ representing <a href="Base.html#M000043">all</a> customers.
169
+ </p>
170
+ </div>
171
+ </div>
172
+
173
+ <div id="method-M000036" class="method-detail">
174
+ <a name="M000036"></a>
175
+
176
+ <div class="method-heading">
177
+ <a href="Base.src/M000036.html" target="Code" class="method-signature"
178
+ onclick="popupCode('Base.src/M000036.html');return false;">
179
+ <span class="method-name">connection</span><span class="method-args">()</span>
180
+ </a>
181
+ </div>
182
+
183
+ <div class="method-description">
184
+ <p>
185
+ Returns the current <a href="Connection.html">Connection</a>
186
+ </p>
187
+ </div>
188
+ </div>
189
+
190
+ <div id="method-M000037" class="method-detail">
191
+ <a name="M000037"></a>
192
+
193
+ <div class="method-heading">
194
+ <a href="Base.src/M000037.html" target="Code" class="method-signature"
195
+ onclick="popupCode('Base.src/M000037.html');return false;">
196
+ <span class="method-name">connection=</span><span class="method-args">(conn)</span>
197
+ </a>
198
+ </div>
199
+
200
+ <div class="method-description">
201
+ <p>
202
+ Sets the current <a href="Connection.html">Connection</a>.
203
+ </p>
204
+ <p>
205
+ This is normally not needed, but in the case that you may want to connect a
206
+ separate <a href="Base.html#M000036">connection</a> to <a
207
+ href="../Quickbooks.html">Quickbooks</a>, you can use this method to
208
+ explicitly set the <a href="Base.html#M000036">connection</a> in a class
209
+ that inherits from <a href="Base.html">Quickbooks::Base</a>.
210
+ </p>
211
+ <pre>
212
+ Quickbooks::Models::Base.connection = Quickbooks::Connection.new('My Test App', 'C:\\Some File.QBW', 'user', 'pass')
213
+ </pre>
214
+ </div>
215
+ </div>
216
+
217
+ <div id="method-M000045" class="method-detail">
218
+ <a name="M000045"></a>
219
+
220
+ <div class="method-heading">
221
+ <a href="Base.src/M000045.html" target="Code" class="method-signature"
222
+ onclick="popupCode('Base.src/M000045.html');return false;">
223
+ <span class="method-name">create</span><span class="method-args">(*args)</span>
224
+ </a>
225
+ </div>
226
+
227
+ <div class="method-description">
228
+ <p>
229
+ Creates a <a href="Base.html#M000046">new</a> object of the current
230
+ class&#8216;s type. For example, Quickbooks::Customer.create(:name =&gt;
231
+ &#8216;Tommy&#8217;) will <a href="Base.html#M000045">create</a> a customer
232
+ object with a Name of Tommy.
233
+ </p>
234
+ </div>
235
+ </div>
236
+
237
+ <div id="method-M000035" class="method-detail">
238
+ <a name="M000035"></a>
239
+
240
+ <div class="method-heading">
241
+ <a href="Base.src/M000035.html" target="Code" class="method-signature"
242
+ onclick="popupCode('Base.src/M000035.html');return false;">
243
+ <span class="method-name">establish_connection</span><span class="method-args">(application_name='RubyApplication', file='', user='', password='', connection_type='localQBD', connection_mode='DoNotCare')</span>
244
+ </a>
245
+ </div>
246
+
247
+ <div class="method-description">
248
+ <p>
249
+ Establishes a <a href="Base.html#M000036">connection</a> to the <a
250
+ href="../Quickbooks.html">Quickbooks</a> RDS Server for <a
251
+ href="Base.html#M000043">all</a> Model Classes
252
+ </p>
253
+ </div>
254
+ </div>
255
+
256
+ <div id="method-M000044" class="method-detail">
257
+ <a name="M000044"></a>
258
+
259
+ <div class="method-heading">
260
+ <a href="Base.src/M000044.html" target="Code" class="method-signature"
261
+ onclick="popupCode('Base.src/M000044.html');return false;">
262
+ <span class="method-name">first</span><span class="method-args">(filters={})</span>
263
+ </a>
264
+ </div>
265
+
266
+ <div class="method-description">
267
+ <p>
268
+ Queries <a href="../Quickbooks.html">Quickbooks</a> for the <a
269
+ href="Base.html#M000044">first</a> object of the current class&#8216;s
270
+ type. For example, Quickbooks::Customer.first will return a <a
271
+ href="Customer.html">Quickbooks::Customer</a> object representing the <a
272
+ href="Base.html#M000044">first</a> customer.
273
+ </p>
274
+ </div>
275
+ </div>
276
+
277
+ <div id="method-M000042" class="method-detail">
278
+ <a name="M000042"></a>
279
+
280
+ <div class="method-heading">
281
+ <a href="Base.src/M000042.html" target="Code" class="method-signature"
282
+ onclick="popupCode('Base.src/M000042.html');return false;">
283
+ <span class="method-name">instantiate</span><span class="method-args">(obj_or_attrs={},attrs={})</span>
284
+ </a>
285
+ </div>
286
+
287
+ <div class="method-description">
288
+ <p>
289
+ Instantiate a <a href="Base.html#M000046">new</a> object with just <a
290
+ href="Base.html#M000047">attributes</a>, or an existing object replacing
291
+ the <a href="Base.html#M000047">attributes</a>
292
+ </p>
293
+ </div>
294
+ </div>
295
+
296
+ <div id="method-M000046" class="method-detail">
297
+ <a name="M000046"></a>
298
+
299
+ <div class="method-heading">
300
+ <a href="Base.src/M000046.html" target="Code" class="method-signature"
301
+ onclick="popupCode('Base.src/M000046.html');return false;">
302
+ <span class="method-name">new</span><span class="method-args">(args={})</span>
303
+ </a>
304
+ </div>
305
+
306
+ <div class="method-description">
307
+ <p>
308
+ The default for <a href="Base.html#M000043">all</a> subclasses is simply to
309
+ apply the <a href="Base.html#M000047">attributes</a> given, and mark the
310
+ object as a <a href="Base.html#M000052">new_record?</a>
311
+ </p>
312
+ </div>
313
+ </div>
314
+
315
+ <div id="method-M000039" class="method-detail">
316
+ <a name="M000039"></a>
317
+
318
+ <div class="method-heading">
319
+ <a href="Base.src/M000039.html" target="Code" class="method-signature"
320
+ onclick="popupCode('Base.src/M000039.html');return false;">
321
+ <span class="method-name">properties</span><span class="method-args">(*args)</span>
322
+ </a>
323
+ </div>
324
+
325
+ <div class="method-description">
326
+ <p>
327
+ Register multiple <a href="Base.html#M000039">properties</a> at once. For
328
+ example:
329
+ </p>
330
+ <pre>
331
+ properties :first_name, :last_name, :phone, :alt_phone
332
+ </pre>
333
+ </div>
334
+ </div>
335
+
336
+ <div id="method-M000038" class="method-detail">
337
+ <a name="M000038"></a>
338
+
339
+ <div class="method-heading">
340
+ <a href="Base.src/M000038.html" target="Code" class="method-signature"
341
+ onclick="popupCode('Base.src/M000038.html');return false;">
342
+ <span class="method-name">property</span><span class="method-args">(*args)</span>
343
+ </a>
344
+ </div>
345
+
346
+ <div class="method-description">
347
+ <p>
348
+ Register a <a href="Base.html#M000038">property</a> in the current class.
349
+ For example in the <a href="Customer.html">Customer</a> class:
350
+ </p>
351
+ <pre>
352
+ property :first_name
353
+ </pre>
354
+ </div>
355
+ </div>
356
+
357
+ <div id="method-M000041" class="method-detail">
358
+ <a name="M000041"></a>
359
+
360
+ <div class="method-heading">
361
+ <a href="Base.src/M000041.html" target="Code" class="method-signature"
362
+ onclick="popupCode('Base.src/M000041.html');return false;">
363
+ <span class="method-name">request</span><span class="method-args">(*args)</span>
364
+ </a>
365
+ </div>
366
+
367
+ <div class="method-description">
368
+ <p>
369
+ Generates a <a href="Base.html#M000041">request</a> using <a
370
+ href="Qbxml/Request.html">Quickbooks::Qbxml::Request</a>, sends it, and
371
+ returns a <a
372
+ href="Qbxml/ResponseSet.html">Quickbooks::Qbxml::ResponseSet</a> object
373
+ containing the response(s).
374
+ </p>
375
+ </div>
376
+ </div>
377
+
378
+ <div id="method-M000040" class="method-detail">
379
+ <a name="M000040"></a>
380
+
381
+ <div class="method-heading">
382
+ <a href="Base.src/M000040.html" target="Code" class="method-signature"
383
+ onclick="popupCode('Base.src/M000040.html');return false;">
384
+ <span class="method-name">request_and_instantiate</span><span class="method-args">(obj_or_args,*args)</span>
385
+ </a>
386
+ </div>
387
+
388
+ <div class="method-description">
389
+ <p>
390
+ Generates a <a href="Base.html#M000041">request</a> by sending *args to
391
+ Quickbooks::Qbxml::Request.new, sends the <a
392
+ href="Base.html#M000041">request</a> over the current <a
393
+ href="Base.html#M000036">connection</a>, and interprets the response using
394
+ <a href="Qbxml/ResponseSet.html">Quickbooks::Qbxml::ResponseSet</a>. The
395
+ response is then instantiated into an object or an array of objects.
396
+ </p>
397
+ <p>
398
+ This method is used mostly internally, but it is the yoke of this library -
399
+ use it to perform custom requests.
400
+ </p>
401
+ </div>
402
+ </div>
403
+
404
+ <h3 class="section-bar">Public Instance methods</h3>
405
+
406
+ <div id="method-M000047" class="method-detail">
407
+ <a name="M000047"></a>
408
+
409
+ <div class="method-heading">
410
+ <a href="Base.src/M000047.html" target="Code" class="method-signature"
411
+ onclick="popupCode('Base.src/M000047.html');return false;">
412
+ <span class="method-name">attributes</span><span class="method-args">()</span>
413
+ </a>
414
+ </div>
415
+
416
+ <div class="method-description">
417
+ <p>
418
+ Returns a hash that represents <a href="Base.html#M000043">all</a> this
419
+ object&#8216;s <a href="Base.html#M000047">attributes</a>.
420
+ </p>
421
+ </div>
422
+ </div>
423
+
424
+ <div id="method-M000048" class="method-detail">
425
+ <a name="M000048"></a>
426
+
427
+ <div class="method-heading">
428
+ <a href="Base.src/M000048.html" target="Code" class="method-signature"
429
+ onclick="popupCode('Base.src/M000048.html');return false;">
430
+ <span class="method-name">attributes=</span><span class="method-args">(attrs)</span>
431
+ </a>
432
+ </div>
433
+
434
+ <div class="method-description">
435
+ <p>
436
+ Updates <a href="Base.html#M000043">all</a> <a
437
+ href="Base.html#M000047">attributes</a> included in <em>attrs</em> to the
438
+ values given. The object will now be <a
439
+ href="Base.html#M000050">dirty?</a>.
440
+ </p>
441
+ </div>
442
+ </div>
443
+
444
+ <div id="method-M000055" class="method-detail">
445
+ <a name="M000055"></a>
446
+
447
+ <div class="method-heading">
448
+ <a href="Base.src/M000055.html" target="Code" class="method-signature"
449
+ onclick="popupCode('Base.src/M000055.html');return false;">
450
+ <span class="method-name">destroy</span><span class="method-args">()</span>
451
+ </a>
452
+ </div>
453
+
454
+ <div class="method-description">
455
+ <p>
456
+ Destroys a record in <a href="../Quickbooks.html">Quickbooks</a>. Note that
457
+ even though <a href="../Quickbooks.html">Quickbooks</a> will <a
458
+ href="Base.html#M000055">destroy</a> the record, the record&#8216;s ListID
459
+ and DeletedTime can be accessed by doing a query for deleted objects of the
460
+ appropriate type.
461
+ </p>
462
+ </div>
463
+ </div>
464
+
465
+ <div id="method-M000050" class="method-detail">
466
+ <a name="M000050"></a>
467
+
468
+ <div class="method-heading">
469
+ <a href="Base.src/M000050.html" target="Code" class="method-signature"
470
+ onclick="popupCode('Base.src/M000050.html');return false;">
471
+ <span class="method-name">dirty?</span><span class="method-args">()</span>
472
+ </a>
473
+ </div>
474
+
475
+ <div class="method-description">
476
+ <p>
477
+ Returns true if any <a href="Base.html#M000047">attributes</a> have changed
478
+ since the object was last loaded or updated from <a
479
+ href="../Quickbooks.html">Quickbooks</a>.
480
+ </p>
481
+ </div>
482
+ </div>
483
+
484
+ <div id="method-M000051" class="method-detail">
485
+ <a name="M000051"></a>
486
+
487
+ <div class="method-heading">
488
+ <a href="Base.src/M000051.html" target="Code" class="method-signature"
489
+ onclick="popupCode('Base.src/M000051.html');return false;">
490
+ <span class="method-name">dirty_attributes</span><span class="method-args">()</span>
491
+ </a>
492
+ </div>
493
+
494
+ <div class="method-description">
495
+ <p>
496
+ Returns a hash of the <a href="Base.html#M000047">attributes</a> and their
497
+ (<a href="Base.html#M000046">new</a>) values that have been changed since
498
+ the object was last loaded or updated from <a
499
+ href="../Quickbooks.html">Quickbooks</a>.
500
+ </p>
501
+ </div>
502
+ </div>
503
+
504
+ <div id="method-M000052" class="method-detail">
505
+ <a name="M000052"></a>
506
+
507
+ <div class="method-heading">
508
+ <a href="Base.src/M000052.html" target="Code" class="method-signature"
509
+ onclick="popupCode('Base.src/M000052.html');return false;">
510
+ <span class="method-name">new_record?</span><span class="method-args">()</span>
511
+ </a>
512
+ </div>
513
+
514
+ <div class="method-description">
515
+ <p>
516
+ Returns true if the object is a <a href="Base.html#M000046">new</a> object
517
+ (that doesn&#8216;t represent an existing object in <a
518
+ href="../Quickbooks.html">Quickbooks</a>).
519
+ </p>
520
+ </div>
521
+ </div>
522
+
523
+ <div id="method-M000049" class="method-detail">
524
+ <a name="M000049"></a>
525
+
526
+ <div class="method-heading">
527
+ <a href="Base.src/M000049.html" target="Code" class="method-signature"
528
+ onclick="popupCode('Base.src/M000049.html');return false;">
529
+ <span class="method-name">original_values</span><span class="method-args">()</span>
530
+ </a>
531
+ </div>
532
+
533
+ <div class="method-description">
534
+ <p>
535
+ Keeps track of the original values the object had when it was instantiated
536
+ from a quickbooks response. <a href="Base.html#M000050">dirty?</a> and <a
537
+ href="Base.html#M000051">dirty_attributes</a> compare the current values
538
+ with these ones.
539
+ </p>
540
+ </div>
541
+ </div>
542
+
543
+ <div id="method-M000054" class="method-detail">
544
+ <a name="M000054"></a>
545
+
546
+ <div class="method-heading">
547
+ <a href="Base.src/M000054.html" target="Code" class="method-signature"
548
+ onclick="popupCode('Base.src/M000054.html');return false;">
549
+ <span class="method-name">reload</span><span class="method-args">()</span>
550
+ </a>
551
+ </div>
552
+
553
+ <div class="method-description">
554
+ <p>
555
+ Reloads the record from <a href="../Quickbooks.html">Quickbooks</a>,
556
+ discarding any changes that have been made to it.
557
+ </p>
558
+ </div>
559
+ </div>
560
+
561
+ <div id="method-M000053" class="method-detail">
562
+ <a name="M000053"></a>
563
+
564
+ <div class="method-heading">
565
+ <a href="Base.src/M000053.html" target="Code" class="method-signature"
566
+ onclick="popupCode('Base.src/M000053.html');return false;">
567
+ <span class="method-name">save</span><span class="method-args">()</span>
568
+ </a>
569
+ </div>
570
+
571
+ <div class="method-description">
572
+ <p>
573
+ Saves the <a href="Base.html#M000047">attributes</a> that have changed.
574
+ </p>
575
+ <p>
576
+ If the EditSequence is out of date but none of the changes conflict, the
577
+ object will be saved to <a href="../Quickbooks.html">Quickbooks</a>. But if
578
+ there are conflicts, the updated values from <a
579
+ href="../Quickbooks.html">Quickbooks</a> will be written to the <a
580
+ href="Base.html#M000049">original_values</a>, and false is returned. This
581
+ way you can deal with the differences (conflicts), if you so desire, and
582
+ simply call <a href="Base.html#M000053">save</a> again to commit your
583
+ changes.
584
+ </p>
585
+ </div>
586
+ </div>
587
+
588
+ <div id="method-M000034" class="method-detail">
589
+ <a name="M000034"></a>
590
+
591
+ <div class="method-heading">
592
+ <a href="Base.src/M000034.html" target="Code" class="method-signature"
593
+ onclick="popupCode('Base.src/M000034.html');return false;">
594
+ <span class="method-name">success?</span><span class="method-args">()</span>
595
+ </a>
596
+ </div>
597
+
598
+ <div class="method-description">
599
+ <p>
600
+ Returns success (true/false) status of the last quickbooks communication
601
+ called from this object.
602
+ </p>
603
+ </div>
604
+ </div>
605
+
606
+
607
+ </div>
608
+
609
+
610
+ </div>
611
+
612
+
613
+ <div id="validator-badges">
614
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
615
+ </div>
616
+
617
+ </body>
618
+ </html>