simplify 1.2.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: a96a3cc9983f666a577ec70105891a6ae1a01f36
-  data.tar.gz: efdd46a334d6134a7c570d74681d831245a49ffa
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWM2NTcwY2YyYmMzNGQ2NmJlMjdhYWQ2Njc3NGE2YTUzYzY2NzJjNA==
+  data.tar.gz: !binary |-
+    ZDZhNzZhZWZmZDcwOWUyOWQ1YjY0ZDJiNDQ4OGYzODg0NzAxNDE3MQ==
 SHA512:
-  metadata.gz: d5a4000459bdfe55c6351841759e2d8d206b1225c8a83e477a7d2420d9a015fee748770f0aeee8bdc2d3e9845d1098ba2ccbec6830abb287389ea63f5e8083c7
-  data.tar.gz: b5b754ac3d89c2693b21e3ecce653b4f24598cc80b90b1f13fb2eb602132e06e9d6617fe74d0a1c221459363daa566dd61d9f0ddb6191d0898d8628362dcc035
+  metadata.gz: !binary |-
+    MDgxNDZmMGExYjg5ZWQ4NWEwMDE1ZjlmNzA4OTRkNDE3MDRjZDhiMjExODll
+    ZGRhZmZlN2I0Y2Q0Nzk2MjAwMGRlNzYxZGRmZTg0M2IxZDI5YzY2OWQ3YThk
+    NzI3ZGZiNGZlNTk4OGU0MjEwOTIwNDA0YThiYTVkYzU0OThiODY=
+  data.tar.gz: !binary |-
+    MzBhOWI4ZGNlYjExODg1ZDZmN2NlMjFhODE4MDY0ODU5OTczOWI2NTk5MTVj
+    MTc0NDk1M2E1ZmE4NDBkMTNmYjA4Njg4MzIxMjNjYmQ0M2VlNWY3YTQ4NjM1
+    NDE5YjcwNDM3M2UzNzEzODBiZTY5ZjdhOGMwNTY2NTYyZGEwY2I=

data/lib/simplify.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 
@@ -32,8 +32,10 @@ require File.dirname(__FILE__) + '/simplify/cardtoken'
 require File.dirname(__FILE__) + '/simplify/chargeback'
 require File.dirname(__FILE__) + '/simplify/coupon'
 require File.dirname(__FILE__) + '/simplify/customer'
+require File.dirname(__FILE__) + '/simplify/datatoken'
 require File.dirname(__FILE__) + '/simplify/deposit'
 require File.dirname(__FILE__) + '/simplify/event'
+require File.dirname(__FILE__) + '/simplify/fraudcheck'
 require File.dirname(__FILE__) + '/simplify/invoice'
 require File.dirname(__FILE__) + '/simplify/invoiceitem'
 require File.dirname(__FILE__) + '/simplify/tax'
@@ -41,5 +43,6 @@ require File.dirname(__FILE__) + '/simplify/payment'
 require File.dirname(__FILE__) + '/simplify/plan'
 require File.dirname(__FILE__) + '/simplify/refund'
 require File.dirname(__FILE__) + '/simplify/subscription'
+require File.dirname(__FILE__) + '/simplify/transactionreview'
 require File.dirname(__FILE__) + '/simplify/webhook'
 

data/lib/simplify/accesstoken.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 

data/lib/simplify/apiexception.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 

data/lib/simplify/authentication.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 

data/lib/simplify/authorization.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 
@@ -60,23 +60,58 @@ class Authorization < Hash
     # Creates an Authorization object
     #
     # parms:: a hash of parameters; valid keys are:
-    # * <code>amount</code>    Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00USD [min value: 50, max value: 9999900] <b>required </b>
+    # * <code>amount</code>    Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00USD <b>required </b>
     # * <code>card => addressCity</code>    City of the cardholder. [max length: 50, min length: 2]
     # * <code>card => addressCountry</code>    Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
     # * <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 code (USPS code) of residence of the cardholder. [max length: 2, min length: 2]
-    # * <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 => 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: 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 [max value: 99] <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>
     # * <code>card => name</code>    Name as it appears on the card. [max length: 50, min length: 2]
     # * <code>card => number</code>    Card number as it appears on the card. [max length: 19, min length: 13] <b>required </b>
     # * <code>currency</code>    Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] <b>required </b>
     # * <code>customer</code>    ID of customer. If specified, card on file of customer will be used.
     # * <code>description</code>    Free form text field to be used as a description of the payment. This field is echoed back with the payment on any find or list operations. [max length: 1024]
+    # * <code>order => commodityCode</code>    Standard classification code for products and services. [max length: 5]
+    # * <code>order => customer</code>    ID of the customer associated with the order.
+    # * <code>order => customerEmail</code>    Customer email address.
+    # * <code>order => customerName</code>    Customer name.
+    # * <code>order => customerNote</code>    Additional notes provided by the customer. [max length: 255]
+    # * <code>order => customerReference</code>    A merchant reference for the customer.
+    # * <code>order => items => amount</code>    Cost of the item.
+    # * <code>order => items => description</code>    Description of the item.
+    # * <code>order => items => name</code>    Item name.
+    # * <code>order => items => product</code>    Product information associated with the item.
+    # * <code>order => items => quantity</code>    Quantity of the item contained in the order [min value: 1, max value: 999999, default: 1] <b>required </b>
+    # * <code>order => items => reference</code>    A merchant reference for the item. [max length: 255]
+    # * <code>order => items => tax</code>    Taxes associated with the item.
+    # * <code>order => merchantNote</code>    Additional notes provided by the merchant. [max length: 255]
+    # * <code>order => payment</code>    ID of the payment associated with the order.
+    # * <code>order => reference</code>    A merchant reference for the order. [max length: 255]
+    # * <code>order => shippingAddress => city</code>    City, town, or municipality. [max length: 255, min length: 2]
+    # * <code>order => shippingAddress => country</code>    2-character country code. [max length: 2, min length: 2]
+    # * <code>order => shippingAddress => line1</code>    Street address. [max length: 255]
+    # * <code>order => shippingAddress => line2</code>    (Opt) Street address continued. [max length: 255]
+    # * <code>order => shippingAddress => name</code>    Name of the entity being shipped to. [max length: 255]
+    # * <code>order => shippingAddress => state</code>    State or province. [max length: 255]
+    # * <code>order => shippingAddress => zip</code>    Postal code. [max length: 32]
+    # * <code>order => shippingFromAddress => city</code>    City, town, or municipality. [max length: 255, min length: 2]
+    # * <code>order => shippingFromAddress => country</code>    2-character country code. [max length: 2, min length: 2]
+    # * <code>order => shippingFromAddress => line1</code>    Street address. [max length: 255]
+    # * <code>order => shippingFromAddress => line2</code>    (Opt) Street address continued. [max length: 255]
+    # * <code>order => shippingFromAddress => name</code>    Name of the entity performing the shipping. [max length: 255]
+    # * <code>order => shippingFromAddress => state</code>    State or province. [max length: 255]
+    # * <code>order => shippingFromAddress => zip</code>    Postal code. [max length: 32]
+    # * <code>order => shippingName</code>    Name of the entity being shipped to.
+    # * <code>order => source</code>    Order source. [default: WEB] <b>required </b>
+    # * <code>order => status</code>    Status of the order. [default: INCOMPLETE] <b>required </b>
     # * <code>reference</code>    Custom reference field to be used with outside systems.
     # * <code>replayId</code>    An identifier that can be sent to uniquely identify a payment request to facilitate retries due to I/O related issues. This identifier must be unique for your account (sandbox or live) across all of your payments. If supplied, we will check for a payment on your account that matches this identifier, and if one is found we will attempt to return an identical response of the original request. [max length: 50, min length: 1]
+    # * <code>statementDescription => name</code>    Merchant name <b>required </b>
+    # * <code>statementDescription => phoneNumber</code>    Merchant contact phone number.
     # * <code>token</code>    If specified, card associated with card token will be used. [max length: 255]
     # 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 a Authorization object.
@@ -99,9 +134,9 @@ class Authorization < Hash
 
     # Retrieve Authorization objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
-    # * <code>max</code>    Allows up to a max of 50 list items to return. [max value: 50, default: 20] 
-    # * <code>offset</code>    Used in pagination of the list. This is the start offset of the page. [default: 0] 
+    # * <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>.
     # 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 Authorization objects and the <code>total</code>

data/lib/simplify/cardtoken.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 
@@ -65,11 +65,11 @@ class CardToken < Hash
     # * <code>card => addressCountry</code>    Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
     # * <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 code (USPS code) of residence of the cardholder. [max length: 2, min length: 2]
-    # * <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 => 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: 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 [max value: 99] <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>
     # * <code>card => name</code>    Name as appears on the card. [max length: 50, min length: 2]
     # * <code>card => number</code>    Card number as it appears on the card. [max length: 19, min length: 13] <b>required </b>
     # * <code>key</code>    Key used to create the card token.

data/lib/simplify/chargeback.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 
@@ -59,9 +59,9 @@ class Chargeback < Hash
 
     # Retrieve Chargeback objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
-    # * <code>max</code>    Allows up to a max of 50 list items to return. [max value: 50, default: 20] 
-    # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [default: 0] 
+    # * <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>.
     # 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 Chargeback objects and the <code>total</code>

data/lib/simplify/constants.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 
@@ -30,7 +30,7 @@ module Simplify
   # Constants.
   class Constants
 
-     @@version = '1.2.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

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 
@@ -60,12 +60,13 @@ class Coupon < Hash
     # Creates an Coupon object
     #
     # parms:: a hash of parameters; valid keys are:
-    # * <code>amountOff</code>    Amount off of the price of the product in the smallest units of the currency of the merchant. While this field is optional, you must provide either amountOff or percentOff for a coupon. Example: 100 = $1.00USD [min value: 1, max value: 9999900]
+    # * <code>amountOff</code>    Amount off of the price of the product in the smallest units of the currency of the merchant. While this field is optional, you must provide either amountOff or percentOff for a coupon. Example: 100 = $1.00USD [min value: 1]
     # * <code>couponCode</code>    Code that identifies the coupon to be used. [min length: 2] <b>required </b>
     # * <code>description</code>    A brief section that describes the coupon.
-    # * <code>durationInMonths</code>    Duration in months that the coupon will be applied after it has first been selected. [min value: 1, max value: 9999]
+    # * <code>durationInMonths</code>    DEPRECATED - Duration in months that the coupon will be applied after it has first been selected. [min value: 1, max value: 9999]
     # * <code>endDate</code>    Last date of the coupon in UTC millis that the coupon can be applied to a subscription. This ends at 23:59:59 of the merchant timezone.
     # * <code>maxRedemptions</code>    Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. [min value: 1]
+    # * <code>numTimesApplied</code>    The number of times a coupon will be applied on a customer's subscription. [min value: 1, max value: 9999]
     # * <code>percentOff</code>    Percentage off of the price of the product. While this field is optional, you must provide either amountOff or percentOff for a coupon. The percent off is a whole number. [min value: 1, max value: 100]
     # * <code>startDate</code>    First date of the coupon in UTC millis that the coupon can be applied to a subscription. This starts at midnight of the merchant timezone. <b>required </b>
     # 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.
@@ -89,10 +90,10 @@ class Coupon < Hash
 
     # Retrieve Coupon objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
-    # * <code>max</code>    Allows up to a max of 50 list items to return. [max value: 50, default: 20] 
-    # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [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> amountOff</code>.
+    # * <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>.
     # 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 Coupon objects and the <code>total</code>
     # property contains the total number of Coupon objects available for the given criteria.

data/lib/simplify/customer.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 
@@ -64,7 +64,7 @@ class Customer < Hash
     # * <code>card => addressCountry</code>    Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. <b>required </b>
     # * <code>card => addressLine1</code>    Address of the cardholder <b>required </b>
     # * <code>card => addressLine2</code>    Address of the cardholder if needed. <b>required </b>
-    # * <code>card => addressState</code>    State code (USPS code) of residence of the cardholder. <b>required </b>
+    # * <code>card => addressState</code>    State of residence of the cardholder. For the US, this is a 2-digit USPS code. <b>required </b>
     # * <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. <b>required </b>
     # * <code>card => cvc</code>    CVC security code of the card. This is the code on the back of the card. Example: 123 <b>required </b>
     # * <code>card => expMonth</code>    Expiration month of the card. Format is MM. Example: January = 01 <b>required </b>
@@ -75,14 +75,18 @@ class Customer < Hash
     # * <code>email</code>    Email address of the customer <b>required </b>
     # * <code>name</code>    Customer name [min length: 2] <b>required </b>
     # * <code>reference</code>    Reference field for external applications use.
-    # * <code>subscriptions => amount</code>    Amount of payment in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 50, max value: 9999900]
+    # * <code>subscriptions => amount</code>    Amount of payment in the smallest unit of your currency. Example: 100 = $1.00USD
+    # * <code>subscriptions => billingCycle</code>    How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]
+    # * <code>subscriptions => billingCycleLimit</code>    The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
     # * <code>subscriptions => coupon</code>    Coupon associated with the subscription for the customer.
     # * <code>subscriptions => currency</code>    Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]
     # * <code>subscriptions => customer</code>    The customer ID to create the subscription for. Do not supply this when creating a customer.
-    # * <code>subscriptions => frequency</code>    Frequency of payment for the plan. Example: Monthly
+    # * <code>subscriptions => frequency</code>    Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".
+    # * <code>subscriptions => frequencyPeriod</code>    Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly.
     # * <code>subscriptions => name</code>    Name describing subscription
     # * <code>subscriptions => plan</code>    The plan ID that the subscription should be created from.
     # * <code>subscriptions => quantity</code>    Quantity of the plan for the subscription. [min value: 1]
+    # * <code>subscriptions => renewalReminderLeadDays</code>    If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null, then no emails are sent. Minimum value is 7 if set.
     # * <code>token</code>    If specified, card associated with card token will be used
     # 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 a Customer object.
@@ -105,9 +109,9 @@ class Customer < Hash
 
     # Retrieve Customer objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
-    # * <code>max</code>    Allows up to a max of 50 list items to return. [max value: 50, default: 20] 
-    # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [default: 0] 
+    # * <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>.
     # 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 Customer objects and the <code>total</code>
@@ -145,7 +149,7 @@ class Customer < Hash
 # * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. <b>(required)</b>
 # * <code>card => addressLine1</code> Address of the cardholder. <b>(required)</b>
 # * <code>card => addressLine2</code> Address of the cardholder if needed. <b>(required)</b>
-# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder. <b>(required)</b>
+# * <code>card => addressState</code> State of residence of the cardholder. For the US, this is a 2-digit USPS code. <b>(required)</b>
 # * <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. <b>(required)</b>
 # * <code>card => cvc</code> CVC security code of the card. This is the code on the back of the card. Example: 123 <b>(required)</b>
 # * <code>card => expMonth</code> Expiration month of the card. Format is MM.  Example: January = 01 <b>(required)</b>

data/lib/simplify/datatoken.rb

@@ -0,0 +1,91 @@
+#
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification, are 
+# permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice, this list of 
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of 
+# conditions and the following disclaimer in the documentation and/or other materials 
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its 
+# contributors may be used to endorse or promote products derived from this software 
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+# SUCH DAMAGE.
+#
+
+require 'simplify/paymentsapi'
+
+module Simplify
+
+# A DataToken object.
+#
+class DataToken < Hash
+
+    # Authentication object used to access the API (See Simplify::Authentication for details)
+    attr_accessor :authentication
+
+    # Returns the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key
+        return self.authentication.public_key
+    end
+
+    # Sets the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key=(k)
+        return self.authentication.public_key = k
+    end
+
+    # Returns the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key
+        return self.authentication.private_key
+    end
+
+    # Sets the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key=(k)
+        return self.authentication.private_key = k
+    end
+
+
+    # Creates an DataToken object
+    #
+    # parms:: a hash of parameters; valid keys are:
+    # 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 a DataToken object.
+    def self.create(parms, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("dataToken", 'create', parms, auth_obj)
+        obj = DataToken.new()
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
+        obj
+    end
+
+    # Retrieve a DataToken object from the API
+    #
+    # id:: ID of object to retrieve
+    # 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 a DataToken object.
+    def self.find(id, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("dataToken", 'show', {"id" => id}, auth_obj)
+        obj = DataToken.new()
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
+        obj
+    end
+
+end
+end

data/lib/simplify/deposit.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 
@@ -59,9 +59,9 @@ class Deposit < Hash
 
     # Retrieve Deposit objects.
     # criteria:: a hash of parameters; valid keys are: 
-    # * <code>filter</code>    Filters to apply to the list. 
-    # * <code>max</code>    Allows up to a max of 50 list items to return. [max value: 50, default: 20] 
-    # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page. [default: 0] 
+    # * <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>.
     # 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 Deposit objects and the <code>total</code>

data/lib/simplify/event.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2014 MasterCard International Incorporated
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without modification, are 

data/lib/simplify/fraudcheck.rb

@@ -0,0 +1,145 @@
+#
+# Copyright (c) 2013 - 2016 MasterCard International Incorporated
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification, are 
+# permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice, this list of 
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of 
+# conditions and the following disclaimer in the documentation and/or other materials 
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its 
+# contributors may be used to endorse or promote products derived from this software 
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+# SUCH DAMAGE.
+#
+
+require 'simplify/paymentsapi'
+
+module Simplify
+
+# A FraudCheck object.
+#
+class FraudCheck < Hash
+
+    # Authentication object used to access the API (See Simplify::Authentication for details)
+    attr_accessor :authentication
+
+    # Returns the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key
+        return self.authentication.public_key
+    end
+
+    # Sets the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key=(k)
+        return self.authentication.public_key = k
+    end
+
+    # Returns the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key
+        return self.authentication.private_key
+    end
+
+    # Sets the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key=(k)
+        return self.authentication.private_key = k
+    end
+
+
+    # Creates an FraudCheck object
+    #
+    # parms:: a hash of parameters; valid keys are:
+    # * <code>amount</code>    Amount of the transaction to be checked for fraud (in the smallest unit of your currency). Example: 100 = $1.00USD. This field is required if using “full” or “advanced” mode.
+    # * <code>card => addressCity</code>    City of the cardholder. [max length: 50, min length: 2]
+    # * <code>card => addressCountry</code>    Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
+    # * <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: 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>
+    # * <code>card => name</code>    Name as it appears on the card. [max length: 50, min length: 2]
+    # * <code>card => number</code>    Card number as it appears on the card. [max length: 19, min length: 13] <b>required </b>
+    # * <code>currency</code>    Currency code (ISO-4217) for the transaction to be checked for fraud. This field is required if using “full” or “advanced” mode.
+    # * <code>description</code>    - Description of the fraud check. [max length: 255]
+    # * <code>ipAddress</code>    IP Address of the customer for which the fraud check is to be done. [max length: 45]
+    # * <code>mode</code>    Fraud check mode.  “simple” only does an AVS and CVC check; “advanced” does a complete fraud check, running the input against the set up rules. [valid values: simple, advanced, full] <b>required </b>
+    # * <code>sessionId</code>    Session ID used during data collection. [max length: 255]
+    # * <code>token</code>    Card token token representing card details for the card to be checked. [max length: 255]
+    # 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 a FraudCheck object.
+    def self.create(parms, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("fraudCheck", 'create', parms, auth_obj)
+        obj = FraudCheck.new()
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
+        obj
+    end
+
+    # Retrieve FraudCheck objects.
+    # criteria:: a hash of parameters; valid keys are: 
+    # * <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>    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.
+    def self.list(criteria = nil, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("fraudCheck", 'list', criteria, auth_obj)
+        obj = FraudCheck.new()
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
+        obj
+
+    end
+
+    # Retrieve a FraudCheck object from the API
+    #
+    # id:: ID of object to retrieve
+    # 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 a FraudCheck object.
+    def self.find(id, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("fraudCheck", 'show', {"id" => id}, auth_obj)
+        obj = FraudCheck.new()
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
+        obj
+    end
+
+    # Updates this object
+    #
+    # The properties that can be updated:
+    # * <code>integratorAuthCode</code> Authorization code for the transaction. [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".
+    def update()
+          h = Simplify::PaymentsApi.execute("fraudCheck", 'update', self, self.authentication)
+          self.merge!(h)
+          self
+    end
+
+end
+end