From ebcabc523144c2a68a0c9741ac48b4437fb04113 Mon Sep 17 00:00:00 2001
From: "Bradley M. Kuhn" <bkuhn@ebb.org>
Date: Wed, 22 Nov 2017 13:32:30 -0800
Subject: [PATCH] holdRequest(): Document function API.

---
 Supporters/lib/Supporters.pm | 40 +++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/Supporters/lib/Supporters.pm b/Supporters/lib/Supporters.pm
index b7ffabf..b4d5569 100644
--- a/Supporters/lib/Supporters.pm
+++ b/Supporters/lib/Supporters.pm
@@ -1371,7 +1371,45 @@ sub fulfillFailure($$) {
 
 =begin holdRequest
 
-FIXME: docs
+Arguments:
+
+=item $parmas
+
+A hash reference, the following keys are considered:
+
+=over
+
+=item donorId
+
+   Valid donor_id number currently in the database.  die() will occur if
+   the id number is not in the database already as a supporter id.
+
+=item requestType / requestTypeId
+
+   If one or both of these parameters is defined, they are used as arguments
+   to C<getRequest()> method.  die()'s if neither is defined.
+
+=item who
+
+   For adding a hold request, the string indicating who put the request on hold.
+
+=item holdReleaseDate
+
+   For adding a hold request, contain an ISO 8601 formatted date for the
+   date to release the hold.  die() may occur if not in ISO-8601 format.
+
+=item heldBecause
+
+   For adding a hold request, the string indicating reason the request is on hold.
+
+
+=back
+
+Returns:
+
+Id of the hold request.  This could be the id of a different hold with
+different details.  See FIXME note in the test code for holdRequest() for
+more detials.
 
 =cut