simplify 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 545d426adaf264152b6db339b5ba1946666d2a4d
-  data.tar.gz: f2de05a3f0e4aac1683f1e0ddde009b6f6f36d4b
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWM2NTcwY2YyYmMzNGQ2NmJlMjdhYWQ2Njc3NGE2YTUzYzY2NzJjNA==
+  data.tar.gz: !binary |-
+    ZDZhNzZhZWZmZDcwOWUyOWQ1YjY0ZDJiNDQ4OGYzODg0NzAxNDE3MQ==
 SHA512:
-  metadata.gz: d4e4b7413b649e8b1b099070181cd5ffebe02b964dcc3823c3c19e3e3b736caae227407d696e372618d8446edef3ceccf23fa7a9ca4d074722d7e2f4889dcf8f
-  data.tar.gz: 7f6dfa44d51b3419cfc9d4ffecc266361e755590fc89f702d28d5758a8c512fcc93d673c2125951198da2fbbc9be5e457b3586b904cef209ffc1ef5918ba92cd
+  metadata.gz: !binary |-
+    MDgxNDZmMGExYjg5ZWQ4NWEwMDE1ZjlmNzA4OTRkNDE3MDRjZDhiMjExODll
+    ZGRhZmZlN2I0Y2Q0Nzk2MjAwMGRlNzYxZGRmZTg0M2IxZDI5YzY2OWQ3YThk
+    NzI3ZGZiNGZlNTk4OGU0MjEwOTIwNDA0YThiYTVkYzU0OThiODY=
+  data.tar.gz: !binary |-
+    MzBhOWI4ZGNlYjExODg1ZDZmN2NlMjFhODE4MDY0ODU5OTczOWI2NTk5MTVj
+    MTc0NDk1M2E1ZmE4NDBkMTNmYjA4Njg4MzIxMjNjYmQ0M2VlNWY3YTQ4NjM1
+    NDE5YjcwNDM3M2UzNzEzODBiZTY5ZjdhOGMwNTY2NTYyZGEwY2I=

data/lib/simplify/authorization.rb

@@ -66,7 +66,7 @@ class Authorization < Hash
     # * <code>card => addressLine1</code>    Address of the cardholder. [max length: 255]
     # * <code>card => addressLine2</code>    Address of the cardholder if needed. [max length: 255]
     # * <code>card => addressState</code>    State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255]
-    # * <code>card => addressZip</code>    Postal code of the cardholder. The postal code size is between 5 and 9 characters in length and only contains numbers or letters. [max length: 9, min length: 3]
+    # * <code>card => addressZip</code>    Postal code of the cardholder. The postal code size is between 5 and 9 characters in length and only contains numbers or letters. [max length: 32]
     # * <code>card => cvc</code>    CVC security code of the card. This is the code on the back of the card. Example: 123
     # * <code>card => expMonth</code>    Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] <b>required </b>
     # * <code>card => expYear</code>    Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] <b>required </b>
@@ -134,7 +134,7 @@ class Authorization < Hash
 
     # Retrieve Authorization objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the Authorization Id</td></tr><tr><td>filter.replayId</td><td>Filter by the compoundReplayId</td></tr><tr><td>filter.last4</td><td>Filter by the card number (last 4 digits)</td></tr><tr><td>filter.amount</td><td>Filter by the transaction amount (in the smallest unit of your currency)</td></tr><tr><td>filter.text</td><td>Filter by the description of the authorization</td></tr><tr><td>filter.amountMin & filter.amountMax</td><td>The filter amountMin must be used with amountMax to find authorizations with authorization values between the min and max</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.deposit</td><td>Filter by the deposit id</td></tr><tr><td>filter.customer</td><td>Filter using the Id of the customer to find the authorizations for that customer</td></tr><tr><td>filter.status</td><td>Filter by the authorization status text</td></tr><tr><td>filter.authCode</td><td>Filter by the authorization code (Not the authorization ID)</td></tr><tr><td>filter.q</td><td>You can use this to filter by the ID, the authCode or the amount of the authorization</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in pagination of the list. This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> dateCreated</code><code> amount</code><code> id</code><code> description</code><code> paymentDate</code>.

data/lib/simplify/cardtoken.rb

@@ -66,7 +66,7 @@ class CardToken < Hash
     # * <code>card => addressLine1</code>    Address of the cardholder. [max length: 255]
     # * <code>card => addressLine2</code>    Address of the cardholder if needed. [max length: 255]
     # * <code>card => addressState</code>    State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255]
-    # * <code>card => addressZip</code>    Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 9, min length: 3]
+    # * <code>card => addressZip</code>    Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 32]
     # * <code>card => cvc</code>    CVC security code of the card. This is the code on the back of the card. Example: 123
     # * <code>card => expMonth</code>    Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] <b>required </b>
     # * <code>card => expYear</code>    Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] <b>required </b>

data/lib/simplify/chargeback.rb

@@ -59,7 +59,7 @@ class Chargeback < Hash
 
     # Retrieve Chargeback objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.text</td><td>Filter by the description of the chargeback </td></tr><tr><td>filter.id</td><td>Filter by the chargeback Id</td></tr><tr><td>filter.amount</td><td>Filter by the chargeback amount (in the smallest unit of your currency)</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.chargebackDateMin<sup>*</sup></td><td>Filter by the earliest chargeback date you are searching for - Date in UTC millis</td></tr><tr><td>filter.chargebackDateMax<sup>*</sup></td><td>Filter by the latest chargeback date you are searching for - Date in UTC millis</td></tr><tr><td>filter.deposit</td><td>Filter by the deposit id</td></tr><tr><td>filter.q</td><td>You can use this to filter by the Id, the payment card's last 4 digits or the chargeback amount</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax (or chargebackDateMin and chargebackDateMax) in the same filter if you want to search between two created dates 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> id</code><code> amount</code><code> description</code><code> dateCreated</code>.

data/lib/simplify/constants.rb

@@ -30,7 +30,7 @@ module Simplify
   # Constants.
   class Constants
 
-     @@version = '1.6.0'
+     @@version = '1.7.0'
      @@api_base_live_url = 'https://api.simplify.com/v1/api'
      @@api_base_sandbox_url = 'https://sandbox.simplify.com/v1/api'
      @@oauth_base_url = 'https://www.simplify.com/commerce/oauth';

data/lib/simplify/coupon.rb

@@ -90,7 +90,7 @@ class Coupon < Hash
 
     # Retrieve Coupon objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the coupon Id</td></tr><tr><td>filter.text</td><td>Filter by the coupon code</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.startDateMin</td><td>Filter by the minimum coupon start date you are searching for - Date in UTC millis</td></tr><tr><td>filter.startDateMax</td><td>Filter by the maximum coupon start date you are searching for - Date in UTC millis</td></tr><tr><td>filter.endDateMin</td><td>Filter by the minimum coupon end date you are searching for - Date in UTC millis</td></tr><tr><td>filter.endDateMax</td><td>Filter by the maximum coupon end date you are searching for - Date in UTC millis</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> dateCreated</code><code> maxRedemptions</code><code> timesRedeemed</code><code> id</code><code> startDate</code><code> endDate</code><code> percentOff</code><code> couponCode</code><code> durationInMonths</code><code> numTimesApplied</code><code> amountOff</code>.

data/lib/simplify/customer.rb

@@ -109,7 +109,7 @@ class Customer < Hash
 
     # Retrieve Customer objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the customer Id</td></tr><tr><td>filter.text</td><td>Can use this to filter by the name, email or reference for the customer</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> dateCreated</code><code> id</code><code> name</code><code> email</code><code> reference</code>.

data/lib/simplify/deposit.rb

@@ -59,7 +59,7 @@ class Deposit < Hash
 
     # Retrieve Deposit objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the deposit Id</td></tr><tr><td>filter.amount</td><td>Filter by the deposit amount (in the smallest unit of your currency)</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.depositDateMin</td><td>Filter by the earliest deposit date you are searching for - Date in UTC millis</td></tr><tr><td>filter.depositDateMax</td><td>Filter by the latest deposit date you are searching for - Date in UTC millis</td></tr><tr><td>filter.creditCount</td><td>Filter by the creditCount figure for the deposit</td></tr><tr><td>filter.creditAmount</td><td>Filter by the creditAmount figure for the deposit</td></tr><tr><td>filter.debitCount</td><td>Filter by the debitCount figure for the deposit</td></tr><tr><td>filter.debitAmount</td><td>Filter by the debitAmount figure for the deposit</td></tr><tr><td>filter.netCount</td><td>Filter by the netCount figure for the deposit</td></tr><tr><td>filter.netAmount</td><td>Filter by the netAmount figure for the deposit</td></tr><tr><td>filter.q</td><td>You can use this to filter by different figures or strings - can be the Id, creditAmount or the debitAmount for the deposit</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> amount</code><code> dateCreated</code><code> depositDate</code>.

data/lib/simplify/fraudcheck.rb

@@ -66,7 +66,7 @@ class FraudCheck < Hash
     # * <code>card => addressLine1</code>    Address of the cardholder. [max length: 255]
     # * <code>card => addressLine2</code>    Address of the cardholder if needed. [max length: 255]
     # * <code>card => addressState</code>    State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255]
-    # * <code>card => addressZip</code>    Postal code of the cardholder. The postal code size is between 5 and 9 characters in length and only contains numbers or letters. [max length: 9, min length: 3]
+    # * <code>card => addressZip</code>    Postal code of the cardholder. The postal code size is between 5 and 9 characters in length and only contains numbers or letters. [max length: 32]
     # * <code>card => cvc</code>    CVC security code of the card. This is the code on the back of the card. Example: 123
     # * <code>card => expMonth</code>    Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] <b>required </b>
     # * <code>card => expYear</code>    Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] <b>required </b>
@@ -92,10 +92,10 @@ class FraudCheck < Hash
 
     # Retrieve FraudCheck objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Allows for ascending or descending sorting of the list. 
+    # * <code>filter</code>    Filters to apply to the list. 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
-    # * <code>sorting</code>    Used in paging of the list.  This is the start offset of the page. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> amount</code><code> dateCreated</code><code> fraudResult</code>.
+    # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> amount</code><code> dateCreated</code><code> fraudResult</code>.
     # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns an object where the <code>list</code> property contains the list of FraudCheck objects and the <code>total</code>
     # property contains the total number of FraudCheck objects available for the given criteria.
@@ -129,9 +129,9 @@ class FraudCheck < Hash
     #
     # The properties that can be updated:
     # * <code>integratorAuthCode</code> Authorization code for the transaction. [max length: 255]
-# * <code>integratorAvsAddress</code> AVS address response. [max length: 255]
-# * <code>integratorAvsZip</code> AVS zip response. [max length: 255]
-# * <code>integratorCvc</code> CVC response. [max length: 255]
+# * <code>integratorAvsAddressResponse</code> AVS address response. [max length: 255]
+# * <code>integratorAvsZipResponse</code> AVS zip response. [max length: 255]
+# * <code>integratorCvcResponse</code> CVC response. [max length: 255]
 # * <code>integratorDeclineReason</code> Reason for the decline if applicable. [max length: 255]
 # * <code>integratorTransactionRef</code> Reference id for the transaction. [max length: 255] <b>(required)</b>
 # * <code>integratorTransactionStatus</code> Status of the transaction, valid values are "APPROVED", "DECLINED", "SETTLED", "REFUNDED" or "VOIDED".

data/lib/simplify/invoice.rb

@@ -125,7 +125,7 @@ class Invoice < Hash
 
     # Retrieve Invoice objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the invoice Id</td></tr><tr><td>filter.amount</td><td>Filter by the invoice amount (in the smallest unit of your currency)</td></tr><tr><td>filter.text</td><td>Filter by the name of the invoice</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.datePaidMin<sup>*</sup></td><td>Filter by the minimum invoice paid date you are searching for - Date in UTC millis</td></tr><tr><td>filter.datePaidMax<sup>*</sup></td><td>Filter by the maximum invoice paid date you are searching for - Date in UTC millis</td></tr><tr><td>filter.status</td><td>Filter by the status of the invoice</td></tr><tr><td>filter.statuses</td><td>Filter by multiple statuses of different invoices</td></tr><tr><td>filter.customer</td><td>Filter using the Id of the customer linked to the invoice</td></tr><tr><td>filter.type</td><td>Filter by the invoice type</td></tr><tr><td>filter.types</td><td>Filter by multiple invoice types</td></tr><tr><td>filter.invoiceId</td><td>Filter by the user defined invoice id</td></tr><tr><td>filter.reference</td><td>Filter by the invoice reference text</td></tr></table><br><sup>*</sup>The filters datePaidMin and datePaidMax can be used in the same filter if you want to search between the two dates. The same is for dateCreatedMin/dateCreatedMax. 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> id</code><code> invoiceDate</code><code> dueDate</code><code> datePaid</code><code> customer</code><code> status</code><code> dateCreated</code>.

data/lib/simplify/payment.rb

@@ -67,7 +67,7 @@ class Payment < Hash
     # * <code>card => addressLine1</code>    Address of the cardholder. [max length: 255]
     # * <code>card => addressLine2</code>    Address of the cardholder if needed. [max length: 255]
     # * <code>card => addressState</code>    State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255]
-    # * <code>card => addressZip</code>    Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 9, min length: 3]
+    # * <code>card => addressZip</code>    Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 32]
     # * <code>card => cvc</code>    CVC security code of the card. This is the code on the back of the card. Example: 123
     # * <code>card => expMonth</code>    Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] <b>required </b>
     # * <code>card => expYear</code>    Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] <b>required </b>
@@ -130,7 +130,7 @@ class Payment < Hash
 
     # Retrieve Payment objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the payment Id</td></tr><tr><td>filter.replayId</td><td>Filter by the compoundReplayId</td></tr><tr><td>filter.last4</td><td>Filter by the card number (last 4 digits)</td></tr><tr><td>filter.amount</td><td>Filter by the payment amount (in the smallest unit of your currency)</td></tr><tr><td>filter.text</td><td>Filter by the description of the payment</td></tr><tr><td>filter.amountMin & filter.amountMax</td><td>The filter amountMin must be used with amountMax to find payments with payments amounts between the min and max figures</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.deposit</td><td>Filter by the deposit id connected to the payment</td></tr><tr><td>filter.customer</td><td>Filter using the Id of the customer to find the payments for that customer</td></tr><tr><td>filter.status</td><td>Filter by the payment status text</td></tr><tr><td>filter.reference</td><td>Filter by the payment reference text</td></tr><tr><td>filter.authCode</td><td>Filter by the payment authorization code (Not the authorization ID)</td></tr><tr><td>filter.q</td><td>You can use this to filter by the Id, the authCode or the amount of the payment</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> dateCreated</code><code> createdBy</code><code> amount</code><code> id</code><code> description</code><code> paymentDate</code>.

data/lib/simplify/paymentsapi.rb

@@ -44,6 +44,8 @@ module Simplify
   @@api_base_sandbox_url = Constants::api_base_sandbox_url
   @@oauth_base_url = Constants::oauth_base_url
   @@user_agent = nil
+  @@request_timeout = nil
+  @@request_options = nil
 
 
   # Returns the value of the public API key.
@@ -106,6 +108,26 @@ module Simplify
     @@user_agent = ua
   end
 
+  # Returns the timeout in seconds for API requests.
+  def self.request_timeout
+    @@request_timeout
+  end
+
+  # Sets the timeout in seconds for API requests.
+  def self.request_timeout=(s)
+    @@request_timeout = s
+  end
+
+  #:nodoc:
+  def self.request_options
+    @@request_options
+  end
+
+  #:nodoc:
+  def self.request_options=(o)
+    @@request_options = o
+  end
+
 
   class PaymentsApi
 
@@ -222,11 +244,20 @@ module Simplify
         }.merge(opts[:headers] || {})
       })
 
+      if Simplify::request_timeout != nil
+        opts[:timeout] = Simplify::request_timeout
+      end
+
+      if Simplify::request_options != nil
+        opts.merge!(Simplify::request_options)
+      end
+
       begin
         response = RestClient::Request.execute(opts)
         JSON.parse(response.body)
+      rescue RestClient::RequestTimeout => e
+        raise ApiException.new("request timeout", nil, nil)
       rescue RestClient::Exception => e
-
         begin
            errorData = JSON.parse(e.response.body)
         rescue JSON::ParserError => e2
@@ -281,9 +312,19 @@ module Simplify
         }.merge(opts[:headers] || {})
       })
 
+      if Simplify::request_timeout != nil
+        opts[:timeout] = Simplify::request_timeout
+      end
+
+      if Simplify::request_options != nil
+        opts.merge!(Simplify::request_options)
+      end
+
       begin
         response = RestClient::Request.execute(opts)
         JSON.parse(response.body)
+      rescue RestClient::RequestTimeout => e
+        raise ApiException.new("request timeout", nil, nil)
       rescue RestClient::Exception => e
 
         begin

data/lib/simplify/plan.rb

@@ -91,7 +91,7 @@ class Plan < Hash
 
     # Retrieve Plan objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the plan Id</td></tr><tr><td>filter.text</td><td>Filter by the name of the plan</td></tr><tr><td>filter.frequency</td><td>Filter by the frequency of the plan</td></tr><tr><td>filter.amountMin & filter.amountMax</td><td>The filter amountMin must be used with amountMax to find plans with plan values between the min and max figures</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.q</td><td>You can use this to filter by the Id, the name or the amount of the plan</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> dateCreated</code><code> amount</code><code> frequency</code><code> name</code><code> id</code>.

data/lib/simplify/refund.rb

@@ -81,7 +81,7 @@ class Refund < Hash
 
     # Retrieve Refund objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the refund Id</td></tr><tr><td>filter.text</td><td>Filter by the refund description text</td></tr><tr><td>filter.replayId</td><td>Filter by the compoundReplayId</td></tr><tr><td>filter.authCode</td><td>Filter by the authorization code (Not authorization ID)</td></tr><tr><td>filter.amount</td><td>Filter by the refund amount (in the smallest unit of your currency)</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.deposit</td><td>Filter by the deposit id</td></tr><tr><td>filter.q</td><td>You can use this to filter by the Id, the authCode or the amount of the refund</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> id</code><code> amount</code><code> description</code><code> dateCreated</code><code> paymentDate</code>.

data/lib/simplify/subscription.rb

@@ -93,10 +93,10 @@ class Subscription < Hash
 
     # Retrieve Subscription objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.customer</td><td>Filter by the Id of the customer with the subscription</td></tr><tr><td>filter.plan</td><td>Filter by the Id of the plan linked to the subscription</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.q</td><td>You can use this to filter by the Id, the name or the amount of the subscription</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
-    # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> id</code><code> plan</code>.
+    # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> dateCreated</code><code> id</code><code> plan</code>.
     # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns an object where the <code>list</code> property contains the list of Subscription objects and the <code>total</code>
     # property contains the total number of Subscription objects available for the given criteria.

data/lib/simplify/tax.rb

@@ -83,7 +83,7 @@ class Tax < Hash
 
     # Retrieve Tax objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the Id of the tax</td></tr><tr><td>filter.label</td><td>Filter by the label(name) of the tax</td></tr></table> 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
     # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
     # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> id</code><code> label</code>.

data/lib/simplify/transactionreview.rb

@@ -81,10 +81,10 @@ class TransactionReview < Hash
 
     # Retrieve TransactionReview objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Allows for ascending or descending sorting of the list. 
+    # * <code>filter</code>    <table class="filter_list"><tr><td>filter.id</td><td>Filter by the Id of the transaction review</td></tr><tr><td>filter.label</td><td>Filter by the status of the transaction review</td></tr></table> 
     # * <code>max</code>    Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] 
-    # * <code>offset</code>    Filters to apply to the list. [min value: 0, default: 0] 
-    # * <code>sorting</code>    Used in paging of the list.  This is the start offset of the page. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> dateCreated</code><code> status</code>.
+    # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [min value: 0, default: 0] 
+    # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> dateCreated</code><code> status</code>.
     # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns an object where the <code>list</code> property contains the list of TransactionReview objects and the <code>total</code>
     # property contains the total number of TransactionReview objects available for the given criteria.

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: simplify
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Simplify Commerce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby access to the Simplify Commerce API
@@ -92,17 +92,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simplify Commerce Ruby SDK