RubyGems - etapper - Versions diffs - 0.0.0 - Mend

etapper 0.0.0

Files changed (650) hide show

data/doc/api/method_login.html ADDED Viewed

@@ -0,0 +1,45 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<div class='methodName'><img src='images/etap.gif'/> login Method</div>
+<table class='reportTable'>
+  <tr class='reportTableHeader'>
+    <td width='20%'>Order</td>
+    <td width='40%'>Name</td>
+    <td>Type</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Return</td>
+    <td>newEndpointURL</td>
+    <td>string</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>loginId</td>
+    <td>string</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Input 2</td>
+    <td>password</td>
+    <td>string</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>A soap fault can occur for the following reasons: Invalid Login (2), Account&nbsp;Locked Out (16), Account&nbsp;Password Expired (17), and Invalid License (15).</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td><b>Important Return Value Details</b>: eTapestry has multiple sites that host customer data. &nbsp;Each site has the exact same API, but different endpoint urls to access it. &nbsp;If the login&nbsp;information provided links to a customer database found on the current site, an empty string will be returned. &nbsp;If the login&nbsp;information provided links to a customer database on another site, a different endpoint url is returned. &nbsp;When a different endpoint url is provided, you must reconnect to the endpoint url provided and retry the&nbsp;login. eTapestry reserves the right to move customer databases from one site to another.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_logout.html ADDED Viewed

@@ -0,0 +1,35 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<div class='methodName'><img src='images/etap.gif'/> logout Method</div>
+<table class='reportTable'>
+  <tr class='reportTableHeader'>
+    <td width='20%'>Order</td>
+    <td width='40%'>Name</td>
+    <td>Type</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Return</td>
+    <td></td>
+    <td></td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>This method will end the api session that began when the <a href='method_login.html'>login</a> method was called.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td>This method has no return value.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_reverseTransaction.html ADDED Viewed

@@ -0,0 +1,53 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<div class='methodName'><img src='images/etap.gif'/> reverseTransaction Method</div>
+<table class='reportTable'>
+  <tr class='reportTableHeader'>
+    <td width='20%'>Order</td>
+    <td width='40%'>Name</td>
+    <td>Type</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Return</td>
+    <td>transactionRef</td>
+    <td>string</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>transactionRef</td>
+    <td>string</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Input 2</td>
+    <td>note</td>
+    <td>string</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>This method will reverse a transaction (i.e. create a copy of the transaction with an inverse amount) and add this new transaction to the journal of the original transaction's owner. &nbsp;The new transaction is called the reversal and the original is considered the reversed.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td>A soap fault will occur if the parameter transactionRef is empty or invalid.</td>
+  </tr>
+  <tr>
+    <td>3)</td>
+    <td>The note provided will be added to the note field of the newly created transaction.</td>
+  </tr>
+  <tr>
+    <td>4)</td>
+    <td>The following transaction types cannot be reversed: <a href='ct_RecurringGiftSchedule.html'>RecurringGiftSchedule</a> and <a href='ct_SoftCredit.html'>SoftCredit</a>. &nbsp;Needless to say, reversed or reversal transactions cannot be reversed.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_updateAccount.html ADDED Viewed

@@ -0,0 +1,53 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<div class='methodName'><img src='images/etap.gif'/> updateAccount Method</div>
+<table class='reportTable'>
+  <tr class='reportTableHeader'>
+    <td width='20%'>Order</td>
+    <td width='40%'>Name</td>
+    <td>Type</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Return</td>
+    <td>accountRef</td>
+    <td>string</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>account</td>
+    <td><a href='ct_Account.html'>Account</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Input 2</td>
+    <td>createFieldAndValues</td>
+    <td>boolean</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>This method will update an existing account.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td>A soap fault will occur if the parameter account is empty or invalid. &nbsp;Review <a href='ct_Account.html'>Account</a> to help avoid a soap fault.</td>
+  </tr>
+  <tr>
+    <td>3)</td>
+    <td>This method will add or update the <a href='ct_Account.html'>Account</a> personaType provided depending on whether the account already has the personaType. &nbsp;If the <a href='ct_Account.html'>Account</a> personaType is empty, the account's primary persona will be updated.</td>
+  </tr>
+  <tr>
+    <td>4)</td>
+    <td>If the parameter createFieldAndValues is true, this indicates all <a href='ct_DefinedValue.html'>DefinedValue</a> fields and values that aren't located will be created. &nbsp;When this parameter is set to true, don't forget to set each <a href='ct_DefinedValue.html'>DefinedValue</a> dataType and displayType to appropriate values. &nbsp;Please note, the personaType will not be created if it is invalid.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_updateContact.html ADDED Viewed

@@ -0,0 +1,49 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<div class='methodName'><img src='images/etap.gif'/> updateContact Method</div>
+<table class='reportTable'>
+  <tr class='reportTableHeader'>
+    <td width='20%'>Order</td>
+    <td width='40%'>Name</td>
+    <td>Type</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Return</td>
+    <td>contactRef</td>
+    <td>string</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>contact</td>
+    <td><a href='ct_Contact.html'>Contact</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Input 2</td>
+    <td>createFieldAndValues</td>
+    <td>boolean</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>This method will update an existing journal contact.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td>A soap fault will occur if the parameter contact is empty or invalid. &nbsp;Review <a href='ct_Contact.html'>Contact</a> to help avoid a soap fault.</td>
+  </tr>
+  <tr>
+    <td>3)</td>
+    <td>If the parameter createFieldAndValues is true, the following items will be created if they aren't located: the <a href='ct_Contact.html'>Contact</a> method and all <a href='ct_DefinedValue.html'>DefinedValue</a> fields and values. &nbsp;When this parameter is set to true, don't forget to set each <a href='ct_DefinedValue.html'>DefinedValue</a> dataType and displayType to appropriate values.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_updateGift.html ADDED Viewed

@@ -0,0 +1,53 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<div class='methodName'><img src='images/etap.gif'/> updateGift Method</div>
+<table class='reportTable'>
+  <tr class='reportTableHeader'>
+    <td width='20%'>Order</td>
+    <td width='40%'>Name</td>
+    <td>Type</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Return</td>
+    <td>transactionRef</td>
+    <td>string</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>gift</td>
+    <td><a href='ct_Gift.html'>Gift</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Input 2</td>
+    <td>createFieldAndValues</td>
+    <td>boolean</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>This method will modify an existing gift transaction.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td>A soap fault will occur if the parameter gift is empty or invalid. &nbsp;Review <a href='ct_Gift.html'>Gift</a> to help avoid a soap fault.</td>
+  </tr>
+  <tr>
+    <td>3)</td>
+    <td>Reversed or reversal transactions (i.e. those with an offsettingRef value) cannot be updated. &nbsp;Also, the gift amount and valuable type cannot be changed for gifts that have been processed.</td>
+  </tr>
+  <tr>
+    <td>4)</td>
+    <td>If the parameter createFieldAndValues is true, the following items will be created if they aren't located: fund, campaign, approach, letter, and all <a href='ct_DefinedValue.html'>DefinedValue</a> fields and values. &nbsp;When this parameter is set to true, don't forget to set each <a href='ct_DefinedValue.html'>DefinedValue</a> dataType and displayType to appropriate values.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_updateNote.html ADDED Viewed

@@ -0,0 +1,49 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<div class='methodName'><img src='images/etap.gif'/> updateNote Method</div>
+<table class='reportTable'>
+  <tr class='reportTableHeader'>
+    <td width='20%'>Order</td>
+    <td width='40%'>Name</td>
+    <td>Type</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Return</td>
+    <td>noteRef</td>
+    <td>string</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>note</td>
+    <td><a href='ct_Note.html'>Note</a></td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td>Input 2</td>
+    <td>createFieldAndValues</td>
+    <td>boolean</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>This method will update an existing journal note.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td>A soap fault will occur if the parameter note is empty or invalid. &nbsp;Review <a href='ct_Note.html'>Note</a> to help avoid a soap fault.</td>
+  </tr>
+  <tr>
+    <td>3)</td>
+    <td>If the parameter createFieldAndValues is true, this indicates all <a href='ct_DefinedValue.html'>DefinedValue</a> fields and values that aren't located will be created. &nbsp;When this parameter is set to true, don't forget to set each <a href='ct_DefinedValue.html'>DefinedValue</a> dataType and displayType to appropriate values.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/revisions.html ADDED Viewed

@@ -0,0 +1,69 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+<img src='images/etap.gif'/> <big>Revision History</big>
+<table class='reportTable'>
+  <tr class='reportTableHeader'>
+    <td align='center'>Version</td>
+    <td align='center'>Date</td>
+    <td>Comments</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td align='center'>2.7.0</td>
+    <td align='center'>04.19.2008</td>
+    <td>Updated complex types <a href='ct_Gift.html'>Gift</a>, <a href='ct_Pledge.html'>Pledge</a>, <a href='ct_Payment.html'>Payment</a>, <a href='ct_RecurringGiftSchedule.html'>RecurringGiftSchedule</a>, <a href='ct_RecurringGift.html'>RecurringGift</a>, <a href='ct_Disbursement.html'>Disbursement</a>, <a href='ct_SoftCredit.html'>SoftCredit</a>, <a href='ct_SegmentedPledge.html'>SegmentedPledge</a>, <a href='ct_Note.html'>Note</a>, and <a href='ct_Contact.html'>Contact</a>. &nbsp;Removed method getAccounts and complex type AccountSearch.</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td align='center'>2.6.0</td>
+    <td align='center'>03.15.2008</td>
+    <td>Added method <a href='method_getDuplicateAccounts.html'>getDuplicateAccounts</a>, <a href='method_updateGift.html'>updateGift</a>, and <a href='method_reverseTransaction.html'>reverseTransaction</a>. &nbsp;Added error numbers 106 - 110.</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td align='center'>2.5.0</td>
+    <td align='center'>02.23.2008</td>
+    <td>Added methods <a href='method_getSegmentedDonation.html'>getSegmentedDonation</a> and <a href='method_getSegmentedPledge.html'>getSegmentedPledge</a> and complex types <a href='ct_SegmentedDonation.html'>SegmentedDonation</a> and <a href='ct_SegmentedPledge.html'>SegmentedPledge</a>. &nbsp;Removed method getSegmentedTransaction and complex type segmentedTransaction. &nbsp;Added error numbers 104 and 105.</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td align='center'>2.4.0</td>
+    <td align='center'>11.10.2007</td>
+    <td>Added metohd <a href='method_getQueryResultStats.html'>getQueryResultStats</a>, complex type <a href='ct_QueryResultStats.html'>QueryResultStats</a>, and error numbers 101 - 103.</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td align='center'>2.3.1</td>
+    <td align='center'>04.20.2007</td>
+    <td>Updated complex type <a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a> by removing fields city, state, and postalCode.</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td align='center'>2.3.0</td>
+    <td align='center'>03.03.2007</td>
+    <td>Added method <a href='method_getDuplicateAccount.html'>getDuplicateAccount</a>. &nbsp;Added complex type <a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a>. &nbsp;Added error number 100.</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td align='center'>2.2.0</td>
+    <td align='center'>02.20.2007</td>
+    <td>Added methods <a href='method_addPayment.html'>addPayment</a>, <a href='method_addAndProcessPayment.html'>addAndProcessPayment</a>, <a href='method_addSoftCredit.html'>addSoftCredit</a>, and <a href='method_addDisbursement.html'>addDisbursement</a>. &nbsp;Added final to complex type <a href='ct_SoftCredit.html'>SoftCredit</a>. &nbsp;Added error numbers 97, 98, and 99. &nbsp;Updated error number 2.</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td align='center'>2.1.1</td>
+    <td align='center'>02.02.2007</td>
+    <td>Added accountRoleTypes to complex type AccountSearch. &nbsp;Added error number 96.</td>
+  </tr>
+  <tr class='reportTableRow'>
+    <td align='center'>2.1.0</td>
+    <td align='center'>01.17.2007</td>
+    <td>Added methods getAccounts and <a href='method_getAccountById.html'>getAccountById</a>. &nbsp;Added complex type AccountSearch. &nbsp;Added error numbers 94 and 95.</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td align='center'>2.0.0</td>
+    <td align='center'>12.10.2006</td>
+    <td>Major overhaul to simplify and add functionality.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/robots.txt ADDED Viewed

@@ -0,0 +1,65 @@
+# $Id: robots.txt,v 1.7.2.1 2007/03/23 18:57:07 drumm Exp $
+#
+# robots.txt
+#
+# This file is to prevent the crawling and indexing of certain parts
+# of your site by web crawlers and spiders run by sites like Yahoo!
+# and Google. By telling these "robots" where not to go on your site,
+# you save bandwidth and server resources.
+#
+# This file will be ignored unless it is at the root of your host:
+# Used:    http://example.com/robots.txt
+# Ignored: http://example.com/site/robots.txt
+#
+# For more information about the robots.txt standard, see:
+# http://www.robotstxt.org/wc/robots.html
+#
+# For syntax checking, see:
+# http://www.sxw.org.uk/computing/robots/check.html
+User-agent: *
+Crawl-delay: 10
+# Directories
+Disallow: /database/
+Disallow: /includes/
+Disallow: /misc/
+Disallow: /modules/
+Disallow: /sites/
+Disallow: /themes/
+Disallow: /scripts/
+Disallow: /updates/
+Disallow: /profiles/
+# Files
+Disallow: /xmlrpc.php
+Disallow: /cron.php
+Disallow: /update.php
+Disallow: /install.php
+Disallow: /INSTALL.txt
+Disallow: /INSTALL.mysql.txt
+Disallow: /INSTALL.pgsql.txt
+Disallow: /CHANGELOG.txt
+Disallow: /MAINTAINERS.txt
+Disallow: /LICENSE.txt
+Disallow: /UPGRADE.txt
+# Paths (clean URLs)
+Disallow: /admin/
+Disallow: /aggregator/
+Disallow: /comment/reply/
+Disallow: /contact/
+Disallow: /logout/
+Disallow: /node/add/
+Disallow: /search/
+Disallow: /user/register/
+Disallow: /user/password/
+Disallow: /user/login/
+# Paths (no clean URLs)
+Disallow: /?q=admin/
+Disallow: /?q=aggregator/
+Disallow: /?q=comment/reply/
+Disallow: /?q=contact/
+Disallow: /?q=logout/
+Disallow: /?q=node/add/
+Disallow: /?q=search/
+Disallow: /?q=user/password/
+Disallow: /?q=user/register/
+Disallow: /?q=user/login/