simplify 1.0.0

data/lib/simplify/coupon.rb

@@ -0,0 +1,143 @@
+#
+# Copyright (c) 2013, 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 Coupon object.
+#
+class Coupon < Hash
+
+    # Public key used to access the API.
+    attr_accessor :public_key
+
+    # Private key used to access the API.
+    attr_accessor :private_key
+
+
+
+    # Creates an Coupon object
+    #
+    # parms:: a hash of parameters; valid keys are:
+    # * <code>amountOff</code>    Amount off of the price of the product in minor units in the currency of the merchant. While this field is optional, you must provide either amountOff or percentOff for a coupon. Example: 1000 = 10.00 
+    # * <code>couponCode</code>    Code that identifies the coupon to be used. <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. 
+    # * <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. 
+    # * <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. 
+    # * <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>
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns a Coupon object.
+    def self.create(parms, public_key = nil, private_key = nil)
+        if public_key == nil then
+            public_key = Simplify::public_key
+        end
+        if private_key == nil then
+            private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("coupon", 'create', parms, public_key, private_key)
+        obj = Coupon.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+    # Delete this object
+    def delete()
+        h = Simplify::PaymentsApi.execute("coupon", 'delete', self, self.public_key, self.private_key)
+        self.merge!(h)
+        self
+    end
+
+    # 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.  <b>default:20</b>
+    # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page.  <b>default:0</b>
+    # * <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>. 
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # 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.
+    def self.list(criteria = nil, public_key = nil, private_key = nil)
+
+        if public_key == nil then
+            public_key = Simplify::public_key
+        end
+        if private_key == nil then
+           private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("coupon", 'list', criteria, public_key, private_key)
+        obj = Coupon.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+
+    end
+
+    # Retrieve a Coupon object from the API
+    #
+    # id:: ID of object to retrieve
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns a Coupon object.
+    def self.find(id, public_key = nil, private_key = nil)
+        if public_key == nil then
+             public_key = Simplify::public_key
+        end
+        if private_key == nil then
+            private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("coupon", 'show', {"id" => id}, public_key, private_key)
+        obj = Coupon.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+    # Updates this object
+    #
+    # The properties that can be updated:
+    # * <code>endDate</code> The ending date in UTC millis for the coupon. This must be after the starting date of the coupon. 
+# * <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. 
+    def update()
+          h = Simplify::PaymentsApi.execute("coupon", 'update', self, self.public_key, self.private_key)
+          self.merge!(h)
+          self
+    end
+
+end
+end

data/lib/simplify/customer.rb

@@ -0,0 +1,169 @@
+#
+# Copyright (c) 2013, 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 Customer object.
+#
+class Customer < Hash
+
+    # Public key used to access the API.
+    attr_accessor :public_key
+
+    # Private key used to access the API.
+    attr_accessor :private_key
+
+
+
+    # Creates an Customer object
+    #
+    # parms:: a hash of parameters; valid keys are:
+    # * <code>card => addressCity</code>    City of the cardholder. 
+    # * <code>card => addressCountry</code>    Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. 
+    # * <code>card => addressLine1</code>    Address of the cardholder 
+    # * <code>card => addressLine2</code>    Address of the cardholder if needed. 
+    # * <code>card => addressState</code>    State code (USPS code) of residence of the cardholder. 
+    # * <code>card => addressZip</code>    Postal code of the cardholder. 
+    # * <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 <b>required </b>
+    # * <code>card => expYear</code>    Expiration year of the card. Format is YY. Example: 2013 = 13 <b>required </b>
+    # * <code>card => name</code>    Name as appears on the card. 
+    # * <code>card => number</code>    Card number as it appears on the card. <b>required </b>
+    # * <code>email</code>    Email address of the customer <b>required </b>
+    # * <code>name</code>    Customer name <b>required </b>
+    # * <code>reference</code>    Reference field for external applications use. 
+    # * <code>subscriptions => amount</code>    Amount of payment in minor units. Example: 1000 = 10.00 
+    # * <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. <b>default:USD</b>
+    # * <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 => 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. 
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns a Customer object.
+    def self.create(parms, public_key = nil, private_key = nil)
+        if public_key == nil then
+            public_key = Simplify::public_key
+        end
+        if private_key == nil then
+            private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("customer", 'create', parms, public_key, private_key)
+        obj = Customer.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+    # Delete this object
+    def delete()
+        h = Simplify::PaymentsApi.execute("customer", 'delete', self, self.public_key, self.private_key)
+        self.merge!(h)
+        self
+    end
+
+    # 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.  <b>default:20</b>
+    # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page.  <b>default:0</b>
+    # * <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>. 
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns an object where the <code>list</code> property contains the list of Customer objects and the <code>total</code>
+    # property contains the total number of Customer objects available for the given criteria.
+    def self.list(criteria = nil, public_key = nil, private_key = nil)
+
+        if public_key == nil then
+            public_key = Simplify::public_key
+        end
+        if private_key == nil then
+           private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("customer", 'list', criteria, public_key, private_key)
+        obj = Customer.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+
+    end
+
+    # Retrieve a Customer object from the API
+    #
+    # id:: ID of object to retrieve
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns a Customer object.
+    def self.find(id, public_key = nil, private_key = nil)
+        if public_key == nil then
+             public_key = Simplify::public_key
+        end
+        if private_key == nil then
+            private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("customer", 'show', {"id" => id}, public_key, private_key)
+        obj = Customer.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+    # Updates this object
+    #
+    # The properties that can be updated:
+    # * <code>card => addressCity</code> City of the cardholder. 
+# * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. 
+# * <code>card => addressLine1</code> Address of the cardholder. 
+# * <code>card => addressLine2</code> Address of the cardholder if needed. 
+# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder. 
+# * <code>card => addressZip</code> Postal code of the cardholder. 
+# * <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 <b>(required)</b>
+# * <code>card => expYear</code> Expiration year of the card. Format is YY. Example: 2013 = 13 <b>(required)</b>
+# * <code>card => name</code> Name as appears on the card. 
+# * <code>card => number</code> Card number as it appears on the card. <b>(required)</b>
+# * <code>email</code> Email address of the customer <b>(required)</b>
+# * <code>name</code> Customer name <b>(required)</b>
+# * <code>reference</code> Reference field for external applications use. 
+    def update()
+          h = Simplify::PaymentsApi.execute("customer", 'update', self, self.public_key, self.private_key)
+          self.merge!(h)
+          self
+    end
+
+end
+end

data/lib/simplify/deposit.rb

@@ -0,0 +1,95 @@
+#
+# Copyright (c) 2013, 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 Deposit object.
+#
+class Deposit < Hash
+
+    # Public key used to access the API.
+    attr_accessor :public_key
+
+    # Private key used to access the API.
+    attr_accessor :private_key
+
+
+
+    # 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.  <b>default:20</b>
+    # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page.  <b>default:0</b>
+    # * <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>. 
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns an object where the <code>list</code> property contains the list of Deposit objects and the <code>total</code>
+    # property contains the total number of Deposit objects available for the given criteria.
+    def self.list(criteria = nil, public_key = nil, private_key = nil)
+
+        if public_key == nil then
+            public_key = Simplify::public_key
+        end
+        if private_key == nil then
+           private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("deposit", 'list', criteria, public_key, private_key)
+        obj = Deposit.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+
+    end
+
+    # Retrieve a Deposit object from the API
+    #
+    # id:: ID of object to retrieve
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns a Deposit object.
+    def self.find(id, public_key = nil, private_key = nil)
+        if public_key == nil then
+             public_key = Simplify::public_key
+        end
+        if private_key == nil then
+            private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("deposit", 'show', {"id" => id}, public_key, private_key)
+        obj = Deposit.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+end
+end

data/lib/simplify/event.rb

@@ -0,0 +1,65 @@
+#
+# Copyright (c) 2013, 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
+
+# An Event object
+class Event < Hash
+
+    # Creates a webhook Event object
+    #
+    # params:: a hash of parameters; valid keys are:
+    # * <code>payload</code>  The raw JWS message payload.  <b>required</b>
+    # * <code>url</code> The URL for the webhook.  If present it must match the URL registered for the webhook.
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: API key to use for the API call. If nil, the value of Simplify::private_key will be used.
+
+    def self.create(params, public_key = nil, private_key = nil)
+
+        if public_key == nil then
+            public_key = Simplify::public_key
+        end
+        if private_key == nil then
+            private_key = Simplify::private_key
+        end
+
+  	    h = Simplify::PaymentsApi.jws_decode(params, public_key, private_key)
+
+	    if !h['event']
+	        raise ApiException.new("Incorrect data in webhook event", nil, nil)
+	    end
+
+	    obj = Event.new()
+	    obj = obj.merge(h['event'])
+
+	    obj
+    end
+
+end
+end