processout 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54acb0b48d4da1e1ec473dff88a5b08d8f9ad33e
-  data.tar.gz: bb8a3e1b1add18023f54d3739858909812e96bb0
+  metadata.gz: 63e1163e73bcea9ce6653eba757252dafedca08f
+  data.tar.gz: 36553ed290dab6dedd47e7a5863b6f4e0722d687
 SHA512:
-  metadata.gz: 17aa470d45a37fc7e30b6993925934b80c5e468d7d26d3715c2dfff373c11f7451e730559d8eff4e42d43629904dfa8f51bef43b365556736c94bbcaa9930aee
-  data.tar.gz: 80073b3e9dc0aee204f5963907cdfc39e91536fc59ceda7852ffb876eadbee6ac694e3f8a2505bb1207aa5c5725afce1ac1860a74af9268d4938345a1b312d33
+  metadata.gz: aad70b245a3d7d82da6777f23863a81cfa2468c08b64a729c7d4ebeda8320881b724635ec5edcc0f44b797687798fb4a1784fb8d387a4b590e082726481b2e57
+  data.tar.gz: 6c55f645cb87d5433f5a26184d912a7606a3dcc2775aa6d7390d45e30537ae5a6a5169a6052a1fe407ccfe914ac659cc81564f1ab81a093315562835bfa6d696

data/lib/processout.rb

@@ -1,5 +1,9 @@
 require "processout/version"
+require "processout/gateway_request"
 require "processout/activity"
+require "processout/addon"
+require "processout/api_request"
+require "processout/api_version"
 require "processout/authorization_request"
 require "processout/card"
 require "processout/card_information"
@@ -13,13 +17,16 @@ require "processout/gateway_configuration"
 require "processout/invoice"
 require "processout/invoice_detail"
 require "processout/customer_action"
+require "processout/dunning_action"
 require "processout/plan"
 require "processout/product"
 require "processout/project"
 require "processout/refund"
 require "processout/subscription"
 require "processout/transaction"
+require "processout/transaction_operation"
 require "processout/webhook"
+require "processout/webhook_endpoint"
 
 module ProcessOut
   class Client
@@ -37,6 +44,21 @@ module ProcessOut
       obj = Activity.new(self, data)
     end
 
+    # Create a new Addon instance
+    def addon(data = {})
+      obj = Addon.new(self, data)
+    end
+
+    # Create a new APIRequest instance
+    def api_request(data = {})
+      obj = APIRequest.new(self, data)
+    end
+
+    # Create a new APIVersion instance
+    def api_version(data = {})
+      obj = APIVersion.new(self, data)
+    end
+
     # Create a new AuthorizationRequest instance
     def authorization_request(data = {})
       obj = AuthorizationRequest.new(self, data)
@@ -102,6 +124,11 @@ module ProcessOut
       obj = CustomerAction.new(self, data)
     end
 
+    # Create a new DunningAction instance
+    def dunning_action(data = {})
+      obj = DunningAction.new(self, data)
+    end
+
     # Create a new Plan instance
     def plan(data = {})
       obj = Plan.new(self, data)
@@ -132,11 +159,21 @@ module ProcessOut
       obj = Transaction.new(self, data)
     end
 
+    # Create a new TransactionOperation instance
+    def transaction_operation(data = {})
+      obj = TransactionOperation.new(self, data)
+    end
+
     # Create a new Webhook instance
     def webhook(data = {})
       obj = Webhook.new(self, data)
     end
 
+    # Create a new WebhookEndpoint instance
+    def webhook_endpoint(data = {})
+      obj = WebhookEndpoint.new(self, data)
+    end
+
     
   end
 end

data/lib/processout/activity.rb

@@ -9,6 +9,7 @@ module ProcessOut
     
     attr_reader :id
     attr_reader :project
+    attr_reader :project_id
     attr_reader :title
     attr_reader :content
     attr_reader :level
@@ -20,6 +21,11 @@ module ProcessOut
     end
     
     def project=(val)
+      if val.nil?
+        @project = val
+        return
+      end
+
       if val.instance_of? Project
         @project = val
       else
@@ -30,6 +36,10 @@ module ProcessOut
       
     end
     
+    def project_id=(val)
+      @project_id = val
+    end
+    
     def title=(val)
       @title = val
     end
@@ -56,6 +66,7 @@ module ProcessOut
 
       self.id = data.fetch(:id, nil)
       self.project = data.fetch(:project, nil)
+      self.project_id = data.fetch(:project_id, nil)
       self.title = data.fetch(:title, nil)
       self.content = data.fetch(:content, nil)
       self.level = data.fetch(:level, nil)
@@ -81,6 +92,9 @@ module ProcessOut
       if data.include? "project"
         self.project = data["project"]
       end
+      if data.include? "project_id"
+        self.project_id = data["project_id"]
+      end
       if data.include? "title"
         self.title = data["title"]
       end
@@ -106,6 +120,7 @@ module ProcessOut
       end
       self.id = data.fetch(:id, self.id)
       self.project = data.fetch(:project, self.project)
+      self.project_id = data.fetch(:project_id, self.project_id)
       self.title = data.fetch(:title, self.title)
       self.content = data.fetch(:content, self.content)
       self.level = data.fetch(:level, self.level)

data/lib/processout/addon.rb

@@ -0,0 +1,352 @@
+# The content of this file was automatically generated
+
+require "cgi"
+require "processout/networking/request"
+require "processout/networking/response"
+
+module ProcessOut
+  class Addon
+    
+    attr_reader :id
+    attr_reader :project
+    attr_reader :project_id
+    attr_reader :subscription
+    attr_reader :subscription_id
+    attr_reader :plan
+    attr_reader :plan_id
+    attr_reader :type
+    attr_reader :name
+    attr_reader :amount
+    attr_reader :quantity
+    attr_reader :metadata
+    attr_reader :sandbox
+    attr_reader :created_at
+
+    
+    def id=(val)
+      @id = val
+    end
+    
+    def project=(val)
+      if val.nil?
+        @project = val
+        return
+      end
+
+      if val.instance_of? Project
+        @project = val
+      else
+        obj = Project.new(@client)
+        obj.fill_with_data(val)
+        @project = obj
+      end
+      
+    end
+    
+    def project_id=(val)
+      @project_id = val
+    end
+    
+    def subscription=(val)
+      if val.nil?
+        @subscription = val
+        return
+      end
+
+      if val.instance_of? Subscription
+        @subscription = val
+      else
+        obj = Subscription.new(@client)
+        obj.fill_with_data(val)
+        @subscription = obj
+      end
+      
+    end
+    
+    def subscription_id=(val)
+      @subscription_id = val
+    end
+    
+    def plan=(val)
+      if val.nil?
+        @plan = val
+        return
+      end
+
+      if val.instance_of? Plan
+        @plan = val
+      else
+        obj = Plan.new(@client)
+        obj.fill_with_data(val)
+        @plan = obj
+      end
+      
+    end
+    
+    def plan_id=(val)
+      @plan_id = val
+    end
+    
+    def type=(val)
+      @type = val
+    end
+    
+    def name=(val)
+      @name = val
+    end
+    
+    def amount=(val)
+      @amount = val
+    end
+    
+    def quantity=(val)
+      @quantity = val
+    end
+    
+    def metadata=(val)
+      @metadata = val
+    end
+    
+    def sandbox=(val)
+      @sandbox = val
+    end
+    
+    def created_at=(val)
+      @created_at = val
+    end
+    
+
+    # Initializes the Addon object
+    # Params:
+    # +client+:: +ProcessOut+ client instance
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
+      @client = client
+
+      self.id = data.fetch(:id, nil)
+      self.project = data.fetch(:project, nil)
+      self.project_id = data.fetch(:project_id, nil)
+      self.subscription = data.fetch(:subscription, nil)
+      self.subscription_id = data.fetch(:subscription_id, nil)
+      self.plan = data.fetch(:plan, nil)
+      self.plan_id = data.fetch(:plan_id, nil)
+      self.type = data.fetch(:type, nil)
+      self.name = data.fetch(:name, nil)
+      self.amount = data.fetch(:amount, nil)
+      self.quantity = data.fetch(:quantity, nil)
+      self.metadata = data.fetch(:metadata, nil)
+      self.sandbox = data.fetch(:sandbox, nil)
+      self.created_at = data.fetch(:created_at, nil)
+      
+    end
+
+    # Create a new Addon using the current client
+    def new(data = {})
+      Addon.new(@client, data)
+    end
+
+    # Fills the object with data coming from the API
+    # Params:
+    # +data+:: +Hash+ of data coming from the API
+    def fill_with_data(data)
+      if data.nil?
+        return self
+      end
+      if data.include? "id"
+        self.id = data["id"]
+      end
+      if data.include? "project"
+        self.project = data["project"]
+      end
+      if data.include? "project_id"
+        self.project_id = data["project_id"]
+      end
+      if data.include? "subscription"
+        self.subscription = data["subscription"]
+      end
+      if data.include? "subscription_id"
+        self.subscription_id = data["subscription_id"]
+      end
+      if data.include? "plan"
+        self.plan = data["plan"]
+      end
+      if data.include? "plan_id"
+        self.plan_id = data["plan_id"]
+      end
+      if data.include? "type"
+        self.type = data["type"]
+      end
+      if data.include? "name"
+        self.name = data["name"]
+      end
+      if data.include? "amount"
+        self.amount = data["amount"]
+      end
+      if data.include? "quantity"
+        self.quantity = data["quantity"]
+      end
+      if data.include? "metadata"
+        self.metadata = data["metadata"]
+      end
+      if data.include? "sandbox"
+        self.sandbox = data["sandbox"]
+      end
+      if data.include? "created_at"
+        self.created_at = data["created_at"]
+      end
+      
+      self
+    end
+
+    # Prefills the object with the data passed as parameters
+    # Params:
+    # +data+:: +Hash+ of data
+    def prefill(data)
+      if data.nil?
+        return self
+      end
+      self.id = data.fetch(:id, self.id)
+      self.project = data.fetch(:project, self.project)
+      self.project_id = data.fetch(:project_id, self.project_id)
+      self.subscription = data.fetch(:subscription, self.subscription)
+      self.subscription_id = data.fetch(:subscription_id, self.subscription_id)
+      self.plan = data.fetch(:plan, self.plan)
+      self.plan_id = data.fetch(:plan_id, self.plan_id)
+      self.type = data.fetch(:type, self.type)
+      self.name = data.fetch(:name, self.name)
+      self.amount = data.fetch(:amount, self.amount)
+      self.quantity = data.fetch(:quantity, self.quantity)
+      self.metadata = data.fetch(:metadata, self.metadata)
+      self.sandbox = data.fetch(:sandbox, self.sandbox)
+      self.created_at = data.fetch(:created_at, self.created_at)
+      
+      self
+    end
+
+    # Apply a new addon to the given subscription ID.
+    # Params:
+    # +subscription_id+:: ID of the subscription
+    # +options+:: +Hash+ of options
+    def apply(subscription_id, options = {})
+      self.prefill(options)
+
+      request = Request.new(@client)
+      path    = "/subscriptions/" + CGI.escape(subscription_id) + "/addons"
+      data    = {
+        "plan_id" => @plan_id, 
+        "type" => @type, 
+        "name" => @name, 
+        "amount" => @amount, 
+        "quantity" => @quantity, 
+        "metadata" => @metadata, 
+        "prorate" => options.fetch(:prorate, nil), 
+        "proration_date" => options.fetch(:proration_date, nil), 
+        "preview" => options.fetch(:preview, nil)
+      }
+
+      response = Response.new(request.post(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["addon"]
+      
+      
+      return_values.push(self.fill_with_data(body))
+      
+
+      
+      return_values[0]
+    end
+
+    # Find a subscription's addon by its ID.
+    # Params:
+    # +subscription_id+:: ID of the subscription on which the addon was applied
+    # +addon_id+:: ID of the addon
+    # +options+:: +Hash+ of options
+    def find(subscription_id, addon_id, options = {})
+      self.prefill(options)
+
+      request = Request.new(@client)
+      path    = "/subscriptions/" + CGI.escape(subscription_id) + "/addons/" + CGI.escape(addon_id) + ""
+      data    = {
+
+      }
+
+      response = Response.new(request.get(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["addon"]
+      
+      
+      obj = Addon.new(@client)
+      return_values.push(obj.fill_with_data(body))
+      
+
+      
+      return_values[0]
+    end
+
+    # Save the updated addon attributes.
+    # Params:
+    # +options+:: +Hash+ of options
+    def save(options = {})
+      self.prefill(options)
+
+      request = Request.new(@client)
+      path    = "/subscriptions/" + CGI.escape(@subscription_id) + "/addons/" + CGI.escape(@id) + ""
+      data    = {
+        "plan_id" => @plan_id, 
+        "type" => @type, 
+        "name" => @name, 
+        "amount" => @amount, 
+        "quantity" => @quantity, 
+        "metadata" => @metadata, 
+        "prorate" => options.fetch(:prorate, nil), 
+        "proration_date" => options.fetch(:proration_date, nil), 
+        "preview" => options.fetch(:preview, nil), 
+        "increment_quantity_by" => options.fetch(:increment_quantity_by, nil)
+      }
+
+      response = Response.new(request.put(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["addon"]
+      
+      
+      return_values.push(self.fill_with_data(body))
+      
+
+      
+      return_values[0]
+    end
+
+    # Remove an addon applied to a subscription.
+    # Params:
+    # +subscription_id+:: ID of the subscription on which the addon was applied
+    # +addon_id+:: ID of the addon
+    # +options+:: +Hash+ of options
+    def remove(subscription_id, addon_id, options = {})
+      self.prefill(options)
+
+      request = Request.new(@client)
+      path    = "/subscriptions/" + CGI.escape(subscription_id) + "/addons/" + CGI.escape(addon_id) + ""
+      data    = {
+        "prorate" => options.fetch(:prorate, nil), 
+        "proration_date" => options.fetch(:proration_date, nil), 
+        "preview" => options.fetch(:preview, nil)
+      }
+
+      response = Response.new(request.delete(path, data, options))
+      return_values = Array.new
+      
+      return_values.push(response.success)
+
+      
+      return_values[0]
+    end
+
+    
+  end
+end