Beispiel #1
0
 /**
  * Retrieve Simplify_Coupon objects.
  * @param     array criteria a map of parameters; valid keys are:<dl style="padding-left:10px;">
  *     <dt><tt>filter</tt></dt>    <dd>Filters to apply to the list.  </dd>
  *     <dt><tt>max</tt></dt>    <dd>Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]  </dd>
  *     <dt><tt>offset</tt></dt>    <dd>Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0]  </dd>
  *     <dt><tt>sorting</tt></dt>    <dd>Allows for ascending or descending sorting of the list.  The value maps properties to the sort direction (either <tt>asc</tt> for ascending or <tt>desc</tt> for descending).  Sortable properties are: <tt> dateCreated</tt><tt> maxRedemptions</tt><tt> timesRedeemed</tt><tt> id</tt><tt> startDate</tt><tt> endDate</tt><tt> percentOff</tt><tt> couponCode</tt><tt> durationInMonths</tt><tt> numTimesApplied</tt><tt> amountOff</tt>.</dd></dl>
  * @param     $authentication -  information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  <i>For backwards compatibility the public and private keys may be passed instead of the authentication object.</i>
  * @return    ResourceList a ResourceList object that holds the list of Coupon objects and the total
  *            number of Coupon objects available for the given criteria.
  * @see       ResourceList
  */
 public static function listCoupon($criteria = null, $authentication = null)
 {
     $args = func_get_args();
     $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
     $val = new Simplify_Coupon();
     $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication);
     return $list;
 }
Beispiel #2
0
 /**
  * Retrieve Simplify_InvoiceItem objects.
  * @param     array criteria a map of parameters; valid keys are:<dl style="padding-left:10px;">
  *     <dt><tt>filter</tt></dt>    <dd>Filters to apply to the list.  </dd>
  *     <dt><tt>max</tt></dt>    <dd>Allows up to a max of 50 list items to return.  <strong>default:20</strong></dd>
  *     <dt><tt>offset</tt></dt>    <dd>Used in paging of the list.  This is the start offset of the page.  <strong>default:0</strong></dd>
  *     <dt><tt>sorting</tt></dt>    <dd>Allows for ascending or descending sorting of the list.  The value maps properties to the sort direction (either <tt>asc</tt> for ascending or <tt>desc</tt> for descending).  Sortable properties are: <tt> id</tt><tt> amount</tt><tt> description</tt><tt> invoice</tt>.</dd></dl>
  * @param     string publicKey Public key. If null, the value of static Simplify::$publicKey will be used
  * @param     string privateKey Private key. If null, the value of Simplify::$privateKey will be used
  * @return    ResourceList a ResourceList object that holds the list of InvoiceItem objects and the total
  *            number of InvoiceItem objects available for the given criteria.
  * @see       ResourceList
  */
 public static function listInvoiceItem($criteria = null, $publicKey = null, $privateKey = null)
 {
     $val = new Simplify_InvoiceItem();
     $list = Simplify_PaymentsApi::listObject($val, $criteria, $publicKey, $privateKey);
     return $list;
 }
Beispiel #3
0
 /**
  * Retrieve Simplify_Chargeback objects.
  * @param     array criteria a map of parameters; valid keys are:<dl style="padding-left:10px;">
  *     <dt><tt>filter</tt></dt>    <dd>Filters to apply to the list.  </dd>
  *     <dt><tt>max</tt></dt>    <dd>Allows up to a max of 50 list items to return.  <strong>default:20</strong></dd>
  *     <dt><tt>offset</tt></dt>    <dd>Used in paging of the list.  This is the start offset of the page.  <strong>default:0</strong></dd>
  *     <dt><tt>sorting</tt></dt>    <dd>Allows for ascending or descending sorting of the list.  The value maps properties to the sort direction (either <tt>asc</tt> for ascending or <tt>desc</tt> for descending).  Sortable properties are: <tt> id</tt><tt> amount</tt><tt> description</tt><tt> dateCreated</tt><tt> paymentDate</tt>.</dd></dl>
  * @param     string publicKey Public key. If null, the value of static Simplify::$publicKey will be used
  * @param     string privateKey Private key. If null, the value of Simplify::$privateKey will be used
  * @return    ResourceList a ResourceList object that holds the list of Chargeback objects and the total
  *            number of Chargeback objects available for the given criteria.
  * @see       ResourceList
  */
 public static function listChargeback($criteria = null, $publicKey = null, $privateKey = null)
 {
     $val = new Simplify_Chargeback();
     $list = Simplify_PaymentsApi::listObject($val, $criteria, $publicKey, $privateKey);
     return $list;
 }