simplify 1.2.0 → 1.7.0

data/lib/simplify/invoice.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,30 +60,49 @@ class Invoice < Hash
     # Creates an Invoice object
     #
     # parms:: a hash of parameters; valid keys are:
+    # * <code>billingAddress => city</code>    Billing address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
+    # * <code>billingAddress => country</code>    Billing address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
+    # * <code>billingAddress => line1</code>    Billing address line 1 of the location where the goods or services were supplied. [max length: 255]
+    # * <code>billingAddress => line2</code>    Billing address line 2 of the location where the goods or services were supplied. [max length: 255]
+    # * <code>billingAddress => name</code>    Billing address name of the location where the goods or services were supplied. Will use the customer name if not provided. [max length: 255]
+    # * <code>billingAddress => state</code>    Billing address state of the location where the goods or services were supplied. [max length: 255]
+    # * <code>billingAddress => zip</code>    Billing address zip of the location where the goods or services were supplied. [max length: 32]
+    # * <code>businessAddress => city</code>    Address city of the business that is sending the invoice. [max length: 255, min length: 2]
+    # * <code>businessAddress => country</code>    Address country of the business that is sending the invoice. [max length: 2, min length: 2]
+    # * <code>businessAddress => line1</code>    Address line 1 of the business that is sending the invoice. [max length: 255]
+    # * <code>businessAddress => line2</code>    Address line 2 of the business that is sending the invoice. [max length: 255]
+    # * <code>businessAddress => name</code>    The name of the business that is sending the invoice. [max length: 255]
+    # * <code>businessAddress => state</code>    Address state of the business that is sending the invoice. [max length: 255]
+    # * <code>businessAddress => zip</code>    Address zip of the business that is sending the invoice. [max length: 32]
     # * <code>currency</code>    Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3, default: USD]
-    # * <code>customer</code>    The customer ID of the customer we are invoicing.  This is optional is a name and email are provided
+    # * <code>customer</code>    The customer ID of the customer we are invoicing.  This is optional if invoiceToCopy or a name and email are provided
+    # * <code>customerTaxNo</code>    The tax number or VAT id of the person to whom the goods or services were supplied. [max length: 255]
     # * <code>discountRate</code>    The discount percent as a decimal e.g. 12.5.  This is used to calculate the discount amount which is subtracted from the total amount due before any tax is applied. [max length: 6]
     # * <code>dueDate</code>    The date invoice payment is due.  If a late fee is provided this will be added to the invoice total is the due date has past.
-    # * <code>email</code>    The email of the customer we are invoicing.  This is optional if a customer id is provided.  A new customer will be created using the the name and email.
+    # * <code>email</code>    The email of the customer we are invoicing.  This is optional if customer or invoiceToCopy is provided.  A new customer will be created using the the name and email.
     # * <code>invoiceId</code>    User defined invoice id. If not provided the system will generate a numeric id. [max length: 255]
-    # * <code>items => amount</code>    Amount of the invoice item (the smallest unit of your currency). Example: 100 = $1.00USD [min value: 1, max value: 9999900] <b>required </b>
+    # * <code>invoiceToCopy</code>    The id of an existing invoice to be copied.  This is optional if customer or a name and email are provided
+    # * <code>items => amount</code>    Amount of the invoice item (the smallest unit of your currency). Example: 100 = $1.00USD <b>required </b>
     # * <code>items => description</code>    The description of the invoice item. [max length: 1024]
     # * <code>items => invoice</code>    The ID of the invoice this item belongs to.
-    # * <code>items => product</code>    The product this invoice item refers to. <b>required </b>
+    # * <code>items => product</code>    The product this invoice item refers to.
     # * <code>items => quantity</code>    Quantity of the item.  This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
     # * <code>items => reference</code>    User defined reference field. [max length: 255]
     # * <code>items => tax</code>    The tax ID of the tax charge in the invoice item.
-    # * <code>lateFee</code>    The late fee amount that will be added to the invoice total is the due date is past due.  Value provided must be in the smallest unit of your currency. Example: 100 = $1.00USD [max value: 9999900]
+    # * <code>lateFee</code>    The late fee amount that will be added to the invoice total is the due date is past due.  Value provided must be in the smallest unit of your currency. Example: 100 = $1.00USD
     # * <code>memo</code>    A memo that is displayed to the customer on the invoice payment screen. [max length: 4000]
-    # * <code>name</code>    The name of the customer we are invoicing.  This is optional if a customer id is provided.  A new customer will be created using the the name and email. [max length: 50, min length: 2]
+    # * <code>name</code>    The name of the customer we are invoicing.  This is optional if customer or invoiceToCopy is provided.  A new customer will be created using the the name and email. [max length: 50, min length: 2]
     # * <code>note</code>    This field can be used to store a note that is not displayed to the customer. [max length: 4000]
     # * <code>reference</code>    User defined reference field. [max length: 255]
-    # * <code>shippingAddressLine1</code>    Address Line 1 where the product should be shipped. [max length: 255]
-    # * <code>shippingAddressLine2</code>    Address Line 2 where the product should be shipped. [max length: 255]
-    # * <code>shippingCity</code>    City where the product should be shipped. [max length: 255, min length: 2]
-    # * <code>shippingCountry</code>    Country where the product should be shipped. [max length: 2, min length: 2]
-    # * <code>shippingState</code>    State where the product should be shipped. [max length: 2, min length: 2]
-    # * <code>shippingZip</code>    ZIP code where the product should be shipped. [max length: 9, min length: 5]
+    # * <code>shippingAddress => city</code>    Address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
+    # * <code>shippingAddress => country</code>    Address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
+    # * <code>shippingAddress => line1</code>    Address line 1 of the location where the goods or services were supplied. [max length: 255]
+    # * <code>shippingAddress => line2</code>    Address line 2 of the location where the goods or services were supplied. [max length: 255]
+    # * <code>shippingAddress => name</code>    Address name of the location where the goods or services were supplied. [max length: 255]
+    # * <code>shippingAddress => state</code>    Address state of the location where the goods or services were supplied. [max length: 255]
+    # * <code>shippingAddress => zip</code>    Address zip of the location where the goods or services were supplied. [max length: 32]
+    # * <code>suppliedDate</code>    The date on which the goods or services were supplied.
+    # * <code>taxNo</code>    The tax number or VAT id of the person who supplied the goods or services. [max length: 255]
     # * <code>type</code>    The type of invoice.  One of WEB or MOBILE. [valid values: WEB, MOBILE, default: WEB]
     # 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 Invoice object.
@@ -106,10 +125,10 @@ class Invoice < Hash
 
     # Retrieve Invoice 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> id</code><code> invoiceDate</code><code> dueDate</code><code> datePaid</code><code> customer</code><code> status</code>.
+    # * <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>.
     # 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 Invoice objects and the <code>total</code>
     # property contains the total number of Invoice objects available for the given criteria.
@@ -142,28 +161,50 @@ class Invoice < Hash
     # Updates this object
     #
     # The properties that can be updated:
-    # * <code>datePaid</code> This is the date the invoice was PAID in UTC millis.
+    # * <code>billingAddress => city</code> Billing address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
+# * <code>billingAddress => country</code> Billing address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
+# * <code>billingAddress => line1</code> Billing address line 1 of the location where the goods or services were supplied. [max length: 255]
+# * <code>billingAddress => line2</code> Billing address line 2 of the location where the goods or services were supplied. [max length: 255]
+# * <code>billingAddress => name</code> Billing address name of the location where the goods or services were supplied. [max length: 255]
+# * <code>billingAddress => state</code> Billing address state of the location where the goods or services were supplied. [max length: 255]
+# * <code>billingAddress => zip</code> Billing address zip of the location where the goods or services were supplied. [max length: 32]
+# * <code>businessAddress => city</code> Business address city of the business that is sending the invoice. [max length: 255, min length: 2]
+# * <code>businessAddress => country</code> Business address country of the business that is sending the invoice. [max length: 2, min length: 2]
+# * <code>businessAddress => line1</code> Business address line 1 of the business that is sending the invoice. [max length: 255]
+# * <code>businessAddress => line2</code> Business address line 2 of the business that is sending the invoice. [max length: 255]
+# * <code>businessAddress => name</code> Business address name of the business that is sending the invoice. [max length: 255]
+# * <code>businessAddress => state</code> Business address state of the business that is sending the invoice. [max length: 255]
+# * <code>businessAddress => zip</code> Business address zip of the business that is sending the invoice. [max length: 32]
+# * <code>currency</code> Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3]
+# * <code>customerTaxNo</code> The tax number or VAT id of the person to whom the goods or services were supplied. [max length: 255]
+# * <code>datePaid</code> This is the date the invoice was PAID in UTC millis.
 # * <code>discountRate</code> The discount percent as a decimal e.g. 12.5.  This is used to calculate the discount amount which is subtracted from the total amount due before any tax is applied. [max length: 6]
 # * <code>dueDate</code> The date invoice payment is due.  If a late fee is provided this will be added to the invoice total is the due date has past.
-# * <code>items => amount</code> Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 1, max value: 9999900] <b>(required)</b>
+# * <code>email</code> The email of the customer we are invoicing.  This is optional if customer or invoiceToCopy is provided.  A new customer will be created using the the name and email.
+# * <code>invoiceId</code> User defined invoice id. If not provided the system will generate a numeric id. [max length: 255]
+# * <code>items => amount</code> Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD <b>(required)</b>
 # * <code>items => description</code> The description of the invoice item. [max length: 1024]
 # * <code>items => invoice</code> The ID of the invoice this item belongs to.
-# * <code>items => product</code> The Id of the product this item refers to. <b>(required)</b>
+# * <code>items => product</code> The Id of the product this item refers to.
 # * <code>items => quantity</code> Quantity of the item.  This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
 # * <code>items => reference</code> User defined reference field. [max length: 255]
 # * <code>items => tax</code> The tax ID of the tax charge in the invoice item.
 # * <code>lateFee</code> The late fee amount that will be added to the invoice total is the due date is past due.  Value provided must be in the smallest unit of your currency. Example: 100 = $1.00USD
 # * <code>memo</code> A memo that is displayed to the customer on the invoice payment screen. [max length: 4000]
+# * <code>name</code> The name of the customer we are invoicing.  This is optional if customer or invoiceToCopy is provided.  A new customer will be created using the the name and email. [max length: 50, min length: 2]
 # * <code>note</code> This field can be used to store a note that is not displayed to the customer. [max length: 4000]
 # * <code>payment</code> The ID of the payment.  Use this ID to query the /payment API. [max length: 255]
 # * <code>reference</code> User defined reference field. [max length: 255]
-# * <code>shippingAddressLine1</code> The shipping address line 1 for the product. [max length: 255]
-# * <code>shippingAddressLine2</code> The shipping address line 2 for the product. [max length: 255]
-# * <code>shippingCity</code> The shipping city for the product. [max length: 255, min length: 2]
-# * <code>shippingCountry</code> The shipping country for the product. [max length: 2, min length: 2]
-# * <code>shippingState</code> The shipping state for the product. [max length: 2, min length: 2]
-# * <code>shippingZip</code> The shipping ZIP code for the product. [max length: 9, min length: 5]
+# * <code>shippingAddress => city</code> Address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
+# * <code>shippingAddress => country</code> Address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
+# * <code>shippingAddress => line1</code> Address line 1 of the location where the goods or services were supplied. [max length: 255]
+# * <code>shippingAddress => line2</code> Address line 2 of the location where the goods or services were supplied. [max length: 255]
+# * <code>shippingAddress => name</code> Address name of the location where the goods or services were supplied. [max length: 255]
+# * <code>shippingAddress => state</code> Address state of the location where the goods or services were supplied. [max length: 255]
+# * <code>shippingAddress => zip</code> Address zip of the location where the goods or services were supplied. [max length: 32]
 # * <code>status</code> New status of the invoice.
+# * <code>suppliedDate</code> The date on which the goods or services were supplied.
+# * <code>taxNo</code> The tax number or VAT id of the person who supplied the goods or services. [max length: 255]
     def update()
           h = Simplify::PaymentsApi.execute("invoice", 'update', self, self.authentication)
           self.merge!(h)

data/lib/simplify/invoiceitem.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,10 +60,10 @@ class InvoiceItem < Hash
     # Creates an InvoiceItem object
     #
     # parms:: a hash of parameters; valid keys are:
-    # * <code>amount</code>    Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 1, max value: 9999900] <b>required </b>
+    # * <code>amount</code>    Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD <b>required </b>
     # * <code>description</code>    Individual items of an invoice [max length: 1024]
     # * <code>invoice</code>    The ID of the invoice this item belongs to.
-    # * <code>product</code>    Product ID this item relates to. <b>required </b>
+    # * <code>product</code>    Product ID this item relates to.
     # * <code>quantity</code>    Quantity of the item.  This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
     # * <code>reference</code>    User defined reference field. [max length: 255]
     # * <code>tax</code>    The tax ID of the tax charge in the invoice item.
@@ -104,7 +104,7 @@ class InvoiceItem < Hash
     # Updates this object
     #
     # The properties that can be updated:
-    # * <code>amount</code> Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 1, max value: 9999900]
+    # * <code>amount</code> Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 1]
 # * <code>description</code> Individual items of an invoice
 # * <code>quantity</code> Quantity of the item.  This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999]
 # * <code>reference</code> User defined reference field.

data/lib/simplify/payment.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,25 +60,61 @@ class Payment < Hash
     # Creates an Payment 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]
+    # * <code>amount</code>    Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00USD
     # * <code>authorization</code>    The ID of the authorization being used to capture the payment.
     # * <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 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 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>invoice</code>    ID of invoice for which this payment is being made.
+    # * <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. If found 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>taxExempt</code>    Specify true to indicate that the payment is tax-exempt.
     # * <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 Payment object.
@@ -94,10 +130,10 @@ class Payment < Hash
 
     # Retrieve Payment 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> amount</code><code> id</code><code> description</code><code> paymentDate</code>.
+    # * <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>.
     # 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 Payment objects and the <code>total</code>
     # property contains the total number of Payment objects available for the given criteria.

data/lib/simplify/paymentsapi.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 
@@ -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

@@ -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,10 +60,16 @@ class Plan < Hash
     # Creates an Plan object
     #
     # parms:: a hash of parameters; valid keys are:
-    # * <code>amount</code>    Amount of payment for the plan 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 payment for the plan in the smallest unit of your currency. Example: 100 = $1.00USD <b>required </b>
+    # * <code>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>billingCycleLimit</code>    The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
     # * <code>currency</code>    Currency code (ISO-4217) for the plan. Must match the currency associated with your account. [default: USD] <b>required </b>
-    # * <code>frequency</code>    Frequency of payment for the plan. Example: Monthly <b>required </b>
+    # * <code>frequency</code>    Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY". [default: MONTHLY] <b>required </b>
+    # * <code>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. [min value: 1, default: 1] <b>required </b>
     # * <code>name</code>    Name of the plan [max length: 50, min length: 2] <b>required </b>
+    # * <code>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>trialPeriod</code>    Plan free trial period selection.  Must be Days, Weeks, or Month [default: NONE] <b>required </b>
+    # * <code>trialPeriodQuantity</code>    Quantity of the trial period.  Must be greater than 0 and a whole number. [min value: 1]
     # 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 Plan object.
     def self.create(parms, *auth)
@@ -85,9 +91,9 @@ class Plan < Hash
 
     # Retrieve Plan 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 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>.
     # 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 Plan objects and the <code>total</code>

data/lib/simplify/refund.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,11 +60,13 @@ class Refund < Hash
     # Creates an Refund object
     #
     # parms:: a hash of parameters; valid keys are:
-    # * <code>amount</code>    Amount of the refund in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 1, max value: 9999900] <b>required </b>
-    # * <code>payment</code>    ID of the payment for the refund <b>required </b>
+    # * <code>amount</code>    Amount of the refund in the smallest unit of your currency. Example: 100 = $1.00USD <b>required </b>
+    # * <code>payment</code>    ID of the payment for the refund
     # * <code>reason</code>    Reason for the refund
     # * <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 refund 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 refunds. If supplied, we will check for a refund on your account that matches this identifier. If found we will return an identical response to that 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.
     # 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 Refund object.
     def self.create(parms, *auth)
@@ -79,9 +81,9 @@ class Refund < Hash
 
     # Retrieve Refund 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 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>.
     # 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 Refund objects and the <code>total</code>

data/lib/simplify/subscription.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,14 +60,18 @@ class Subscription < Hash
     # Creates an Subscription 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]
+    # * <code>amount</code>    Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00USD
+    # * <code>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>billingCycleLimit</code>    The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
     # * <code>coupon</code>    Coupon ID associated with the subscription
     # * <code>currency</code>    Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]
     # * <code>customer</code>    Customer that is enrolling in the subscription.
-    # * <code>frequency</code>    Frequency of payment for the plan. Example: Monthly
+    # * <code>frequency</code>    Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".
+    # * <code>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>name</code>    Name describing subscription
     # * <code>plan</code>    The ID of the plan that should be used for the subscription.
     # * <code>quantity</code>    Quantity of the plan for the subscription. [min value: 1]
+    # * <code>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.
     # 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 Subscription object.
     def self.create(parms, *auth)
@@ -89,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>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> id</code><code> plan</code>.
+    # * <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> 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.
@@ -125,14 +129,18 @@ class Subscription < Hash
     # Updates this object
     #
     # The properties that can be updated:
-    # * <code>amount</code> Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 50, max value: 9999900]
+    # * <code>amount</code> Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00USD
+# * <code>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>billingCycleLimit</code> The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
 # * <code>coupon</code> Coupon being assigned to this subscription
 # * <code>currency</code> Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]
-# * <code>frequency</code> Frequency of payment for the plan. Example: Monthly
+# * <code>frequency</code> Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".
+# * <code>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. [min value: 1]
 # * <code>name</code> Name describing subscription
 # * <code>plan</code> Plan that should be used for the subscription.
 # * <code>prorate</code> Whether to prorate existing subscription. [default: true] <b>(required)</b>
 # * <code>quantity</code> Quantity of the plan for the subscription. [min value: 1]
+# * <code>renewalReminderLeadDays</code> If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null or 0, no emails are sent. Minimum value is 7 if set.
     def update()
           h = Simplify::PaymentsApi.execute("subscription", 'update', self, self.authentication)
           self.merge!(h)