simplify 1.0.0

data/lib/simplify/plan.rb

@@ -0,0 +1,138 @@
+#
+# 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 Plan object.
+#
+class Plan < 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 Plan object
+    #
+    # parms:: a hash of parameters; valid keys are:
+    # * <code>amount</code>    Amount of payment for the plan in minor units. Example: 1000 = 10.00 <b>required </b>
+    # * <code>currency</code>    Currency code (ISO-4217) for the plan. Must match the currency associated with your account. <b>required </b><b>default:USD</b>
+    # * <code>frequency</code>    Frequency of payment for the plan. Example: Monthly <b>required </b>
+    # * <code>name</code>    Name of the plan <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 Plan 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("plan", 'create', parms, public_key, private_key)
+        obj = Plan.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("plan", 'delete', self, self.public_key, self.private_key)
+        self.merge!(h)
+        self
+    end
+
+    # 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.  <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> amount</code><code> frequency</code><code> name</code><code> id</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 Plan objects and the <code>total</code>
+    # property contains the total number of Plan 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("plan", 'list', criteria, public_key, private_key)
+        obj = Plan.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+
+    end
+
+    # Retrieve a Plan 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 Plan 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("plan", 'show', {"id" => id}, public_key, private_key)
+        obj = Plan.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>name</code> Name of the plan. <b>(required)</b>
+    def update()
+          h = Simplify::PaymentsApi.execute("plan", 'update', self, self.public_key, self.private_key)
+          self.merge!(h)
+          self
+    end
+
+end
+end

data/lib/simplify/refund.rb

@@ -0,0 +1,120 @@
+#
+# 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 Refund object.
+#
+class Refund < 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 Refund object
+    #
+    # parms:: a hash of parameters; valid keys are:
+    # * <code>amount</code>    Amount of the refund in minor units. Example: 1000 = 10.00 <b>required </b>
+    # * <code>payment</code>    ID of the payment for the refund <b>required </b>
+    # * <code>reason</code>    Reason for the refund 
+    # 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 Refund 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("refund", 'create', parms, public_key, private_key)
+        obj = Refund.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+    # 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.  <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> id</code><code> amount</code><code> description</code><code> dateCreated</code><code> paymentDate</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 Refund objects and the <code>total</code>
+    # property contains the total number of Refund 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("refund", 'list', criteria, public_key, private_key)
+        obj = Refund.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+
+    end
+
+    # Retrieve a Refund 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 Refund 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("refund", 'show', {"id" => id}, public_key, private_key)
+        obj = Refund.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+end
+end

data/lib/simplify/subscription.rb

@@ -0,0 +1,149 @@
+#
+# 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 Subscription object.
+#
+class Subscription < 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 Subscription object
+    #
+    # parms:: a hash of parameters; valid keys are:
+    # * <code>amount</code>    Amount of the payment (minor units). Example: 1000 = 10.00 
+    # * <code>coupon</code>    Coupon ID associated with the subscription 
+    # * <code>currency</code>    Currency code (ISO-4217). Must match the currency associated with your account. <b>default:USD</b>
+    # * <code>customer</code>    Customer that is enrolling in the subscription. 
+    # * <code>frequency</code>    Frequency of payment for the plan. Example: Monthly 
+    # * <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. 
+    # 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 Subscription 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("subscription", 'create', parms, public_key, private_key)
+        obj = Subscription.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("subscription", 'delete', self, self.public_key, self.private_key)
+        self.merge!(h)
+        self
+    end
+
+    # 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.  <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> id</code><code> plan</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 Subscription objects and the <code>total</code>
+    # property contains the total number of Subscription 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("subscription", 'list', criteria, public_key, private_key)
+        obj = Subscription.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+
+    end
+
+    # Retrieve a Subscription 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 Subscription 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("subscription", 'show', {"id" => id}, public_key, private_key)
+        obj = Subscription.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>amount</code> Amount of the payment (minor units). Example: 1000 = 10.00 
+# * <code>coupon</code> Coupon being assigned to this subscription 
+# * <code>currency</code> Currency code (ISO-4217). Must match the currency associated with your account. 
+# * <code>frequency</code> Frequency of payment for the plan. Example: Monthly 
+# * <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. <b>(required)</b>
+# * <code>quantity</code> Quantity of the plan for the subscription. 
+    def update()
+          h = Simplify::PaymentsApi.execute("subscription", 'update', self, self.public_key, self.private_key)
+          self.merge!(h)
+          self
+    end
+
+end
+end

data/lib/simplify/webhook.rb

@@ -0,0 +1,135 @@
+#
+# 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 Webhook object.
+#
+class Webhook < 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 Webhook object
+    #
+    # parms:: a hash of parameters; valid keys are:
+    # * <code>url</code>    Endpoint URL <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 Webhook 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("webhook", 'create', parms, public_key, private_key)
+        obj = Webhook.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("webhook", 'delete', self, self.public_key, self.private_key)
+        self.merge!(h)
+        self
+    end
+
+    # Retrieve Webhook 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>. 
+    # 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 Webhook objects and the <code>total</code>
+    # property contains the total number of Webhook 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("webhook", 'list', criteria, public_key, private_key)
+        obj = Webhook.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+
+    end
+
+    # Retrieve a Webhook 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 Webhook 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("webhook", 'show', {"id" => id}, public_key, private_key)
+        obj = Webhook.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>url</code> Endpoint URL <b>(required)</b>
+    def update()
+          h = Simplify::PaymentsApi.execute("webhook", 'update', self, self.public_key, self.private_key)
+          self.merge!(h)
+          self
+    end
+
+end
+end