RubyGems - etapper - Versions diffs - 0.0.0 - Mend

etapper 0.0.0

Files changed (650) hide show

data/doc/api/method_getCampaigns.html ADDED Viewed

@@ -0,0 +1,36 @@
+<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'/> getCampaigns 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>campaigns</td>
+    <td>string array</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>includeDisabled</td>
+    <td>boolean</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>Campaigns can be located within eTapestry under Manage...Defined Fields...Campaigns.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getContact.html ADDED Viewed

@@ -0,0 +1,36 @@
+<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'/> getContact 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>contact</td>
+    <td><a href='ct_Contact.html'>Contact</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>contactRef</td>
+    <td>string</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>A soap fault will occur if the parameter contactRef is empty or invalid.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getContactByUniqueDefinedValue.html ADDED Viewed

@@ -0,0 +1,40 @@
+<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'/> getContactByUniqueDefinedValue 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>contact</td>
+    <td><a href='ct_Contact.html'>Contact</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>definedValue</td>
+    <td><a href='ct_DefinedValue.html'>DefinedValue</a></td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>The purpose of this method is to locate a single <a href='ct_Contact.html'>Contact</a> with the definedValue provided. &nbsp;If multiple contacts have the definedValue provided, a soap fault (7 - Duplicate Matches Found) will occur. &nbsp;The value traditionally provided is a unique id that is stored within a display type text field.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td>A soap fault will occur if the parameter definedValue is empty or invalid. &nbsp;Review <a href='ct_DefinedValue.html'>DefinedValue</a> to help avoid a soap fault.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getDisbursement.html ADDED Viewed

@@ -0,0 +1,36 @@
+<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'/> getDisbursement 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>disbursement</td>
+    <td><a href='ct_Disbursement.html'>Disbursement</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>transactionRef</td>
+    <td>string</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>A soap fault will occur if the parameter transactionRef is empty or invalid.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getDuplicateAccount.html ADDED Viewed

@@ -0,0 +1,48 @@
+<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'/> getDuplicateAccount 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>account</td>
+    <td><a href='ct_Account.html'>Account</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>duplicateAccountSearch</td>
+    <td><a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a></td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>An <a href='ct_Account.html'>Account</a> will be returned based upon the search content provided within <a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a>. &nbsp;Null will be returned if no account matches the search content provided.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td><b>Important Note</b>: <a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a> provides a way to locate an existing account within eTapestry using name, address, email address, and phone number. At a minimum, one of the following four critieria must be provided to conduct a basic duplicate account search. &nbsp;This is done to ensure enough information is provided to make the search tough enough to alleviate inappropriate results. &nbsp;In essence, locating duplicates simply on name alone isn't appropirate because multiple accounts in the database may have the same name. eTapestry will attempt to locate an account with all of the data provided. If no account contains all of the data provided, eTapestry will attempt to locate an account by each smaller criteria combinations below as appropirate. &nbsp;This means a search based upon name, address, and email will attempt to locate an account with all three items and if not found, a name/email, a name/address, and email (see <a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a> for more details about matching on email alone) search will also be conducted.<ul><li>Name & Email</li><li>Name & Address</li><li>Name & Phone</li><li>Email</li></ul></td>
+  </tr>
+  <tr>
+    <td>3)</td>
+    <td>Using the <a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a> details provided, if eTapestry locates two or more accounts, a random account will be returned. &nbsp;See the method <a href='method_getDuplicateAccounts.html'>getDuplicateAccounts</a> if you prefer to have multiple accounts returned instead of a single account.</td>
+  </tr>
+  <tr>
+    <td>4)</td>
+    <td>A soap fault (100 - Missing Duplicate Search Criteria) will occur if one of the four above basic searches isn't found.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getDuplicateAccounts.html ADDED Viewed

@@ -0,0 +1,48 @@
+<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'/> getDuplicateAccounts 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>accounts</td>
+    <td><a href='ct_Account.html'>Account</a> array</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>duplicateAccountSearch</td>
+    <td><a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a></td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>Accounts will be returned based upon the search content provided within <a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a>. &nbsp;Null will be returned if no accounts match the search content provided.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td><b>Important Note</b>: <a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a> provides a way to locate existing accounts within eTapestry using name, address, email address, and phone number. At a minimum, one of the following four critieria must be provided to conduct a basic duplicate account search. &nbsp;This is done to ensure enough information is provided to make the search tough enough to alleviate inappropriate results. &nbsp;In essence, locating duplicates simply on name alone isn't appropirate because multiple accounts in the database may have the same name. eTapestry will attempt to locate accounts with all of the data provided. If no accounts contain all of the data provided, eTapestry will attempt to locate accounts by each smaller criteria combination below as appropirate. &nbsp;This means a search based upon name, address, and email will attempt to locate an account with all three items and if not found, a name/email, a name/address, and email (see <a href='ct_DuplicateAccountSearch.html'>DuplicateAccountSearch</a> for more details about matching on email alone) search will also be conducted.<ul><li>Name & Email</li><li>Name & Address</li><li>Name & Phone</li><li>Email</li></ul></td>
+  </tr>
+  <tr>
+    <td>3)</td>
+    <td>This method is virtually the same as <a href='method_getDuplicateAccount.html'>getDuplicateAccount</a> except when multiple accounts are located, up to 100 will be returned.</td>
+  </tr>
+  <tr>
+    <td>4)</td>
+    <td>A soap fault (100 - Missing Duplicate Search Criteria) will occur if one of the four above basic searches isn't found.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getFunds.html ADDED Viewed

@@ -0,0 +1,36 @@
+<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'/> getFunds 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>funds</td>
+    <td>string array</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>includeDisabled</td>
+    <td>boolean</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>Funds can be located within eTapestry under Manage...Defined Fields...Funds.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getGift.html ADDED Viewed

@@ -0,0 +1,36 @@
+<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'/> getGift 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>gift</td>
+    <td><a href='ct_Gift.html'>Gift</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>transactionRef</td>
+    <td>string</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>A soap fault will occur if the parameter transactionRef is empty or invalid.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getLetters.html ADDED Viewed

@@ -0,0 +1,36 @@
+<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'/> getLetters 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>letters</td>
+    <td>string array</td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>includeDisabled</td>
+    <td>boolean</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>Letters can be located within eTapestry under Manage...Defined Fields...Letters.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getNote.html ADDED Viewed

@@ -0,0 +1,36 @@
+<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'/> getNote 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>note</td>
+    <td><a href='ct_Note.html'>Note</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>noteRef</td>
+    <td>string</td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>A soap fault will occur if the parameter noteRef is empty or invalid.</td>
+  </tr>
+</table>
+</body>
+</html>

data/doc/api/method_getNoteByUniqueDefinedValue.html ADDED Viewed

@@ -0,0 +1,40 @@
+<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'/> getNoteByUniqueDefinedValue 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>note</td>
+    <td><a href='ct_Note.html'>Note</a></td>
+  </tr>
+  <tr class='reportTableRowAlt'>
+    <td>Input 1</td>
+    <td>definedValue</td>
+    <td><a href='ct_DefinedValue.html'>DefinedValue</a></td>
+  </tr>
+</table><br>
+<div class='specialComments'>Comments</div>
+<table class='specialCommentTable'>
+  <tr>
+    <td>1)</td>
+    <td>The purpose of this method is to locate a single <a href='ct_Note.html'>Note</a> with the definedValue provided. &nbsp;If multiple notes have the definedValue provided, a soap fault (7 - Duplicate Matches Found) will occur. &nbsp;The value traditionally provided is a unique id that is stored within a display type text field.</td>
+  </tr>
+  <tr>
+    <td>2)</td>
+    <td>A soap fault will occur if the parameter definedValue is empty or invalid. &nbsp;Review <a href='ct_DefinedValue.html'>DefinedValue</a> to help avoid a soap fault.</td>
+  </tr>
+</table>
+</body>
+</html>