gocardless_pro 0.3.0

data/lib/gocardless_pro/resources/customer_bank_account.rb

@@ -0,0 +1,80 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Customer Bank Accounts hold the bank details of a
+    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers).
+    # They always belong to a
+    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers),
+    # and may be linked to several Direct Debit
+    # [mandates](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-mandates).
+
+    #  #
+    # Note that customer bank accounts must be unique, and so you will
+    # encounter a `bank_account_exists` error if you try to create a duplicate
+    # bank account. You may wish to handle this by updating the existing record
+    # instead, the ID of which will be provided as links[customer_bank_account] in
+    # the error response.
+    # Represents an instance of a customer_bank_account resource returned from the API
+    class CustomerBankAccount
+      attr_reader :account_holder_name
+
+      attr_reader :account_number_ending
+
+      attr_reader :bank_name
+
+      attr_reader :country_code
+
+      attr_reader :created_at
+
+      attr_reader :currency
+
+      attr_reader :enabled
+
+      attr_reader :id
+
+      attr_reader :metadata
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @account_holder_name = object['account_holder_name']
+        @account_number_ending = object['account_number_ending']
+        @bank_name = object['bank_name']
+        @country_code = object['country_code']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @enabled = object['enabled']
+        @id = object['id']
+        @links = object['links']
+        @metadata = object['metadata']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            customer: ''
+
+          }.keys.sort
+        ).new(*@links.sort.map(&:last))
+      end
+
+      # Provides the resource as a hash of all it's readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/event.rb

@@ -0,0 +1,75 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Events are stored for all webhooks. An event refers to a resource which has
+    # been updated, for example a payment which has been collected, or a mandate
+    # which has been transferred.
+    # Represents an instance of a event resource returned from the API
+    class Event
+      attr_reader :action
+
+      attr_reader :created_at
+
+      attr_reader :details
+
+      attr_reader :id
+
+      attr_reader :metadata
+
+      attr_reader :resource_type
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @action = object['action']
+        @created_at = object['created_at']
+        @details = object['details']
+        @id = object['id']
+        @links = object['links']
+        @metadata = object['metadata']
+        @resource_type = object['resource_type']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            mandate: '',
+
+            new_customer_bank_account: '',
+
+            parent_event: '',
+
+            payment: '',
+
+            payout: '',
+
+            previous_customer_bank_account: '',
+
+            refund: '',
+
+            subscription: ''
+
+          }.keys.sort
+        ).new(*@links.sort.map(&:last))
+      end
+
+      # Provides the resource as a hash of all it's readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/helper.rb

@@ -0,0 +1,29 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    #
+    # Represents an instance of a helper resource returned from the API
+    class Helper
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+      end
+
+      # Provides the resource as a hash of all it's readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/mandate.rb

@@ -0,0 +1,70 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Mandates represent the Direct Debit mandate with a
+    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers).
+
+    #  #
+    # GoCardless will notify you via a
+    # [webhook](https://developer.gocardless.com/pro/2015-04-29/#webhooks)
+    # whenever the status of a mandate changes.
+    # Represents an instance of a mandate resource returned from the API
+    class Mandate
+      attr_reader :created_at
+
+      attr_reader :id
+
+      attr_reader :metadata
+
+      attr_reader :next_possible_charge_date
+
+      attr_reader :reference
+
+      attr_reader :scheme
+
+      attr_reader :status
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @created_at = object['created_at']
+        @id = object['id']
+        @links = object['links']
+        @metadata = object['metadata']
+        @next_possible_charge_date = object['next_possible_charge_date']
+        @reference = object['reference']
+        @scheme = object['scheme']
+        @status = object['status']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            creditor: '',
+
+            customer_bank_account: ''
+
+          }.keys.sort
+        ).new(*@links.sort.map(&:last))
+      end
+
+      # Provides the resource as a hash of all it's readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/payment.rb

@@ -0,0 +1,87 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Payment objects represent payments from a
+    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers)
+    # to a
+    # [creditor](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-creditors),
+    # taken against a Direct Debit
+    # [mandate](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-mandates).
+
+    #  #
+    # GoCardless will notify you via a
+    # [webhook](https://developer.gocardless.com/pro/2015-04-29/#webhooks)
+    # whenever the state of a payment changes.
+    # Represents an instance of a payment resource returned from the API
+    class Payment
+      attr_reader :amount
+
+      attr_reader :amount_refunded
+
+      attr_reader :charge_date
+
+      attr_reader :created_at
+
+      attr_reader :currency
+
+      attr_reader :description
+
+      attr_reader :id
+
+      attr_reader :metadata
+
+      attr_reader :reference
+
+      attr_reader :status
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @amount = object['amount']
+        @amount_refunded = object['amount_refunded']
+        @charge_date = object['charge_date']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @description = object['description']
+        @id = object['id']
+        @links = object['links']
+        @metadata = object['metadata']
+        @reference = object['reference']
+        @status = object['status']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            creditor: '',
+
+            mandate: '',
+
+            payout: '',
+
+            subscription: ''
+
+          }.keys.sort
+        ).new(*@links.sort.map(&:last))
+      end
+
+      # Provides the resource as a hash of all it's readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/payout.rb

@@ -0,0 +1,66 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Payouts represent transfers from GoCardless to a
+    # [creditor](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-creditors).
+    # Each payout contains the funds collected from one or many
+    # [payments](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payments).
+    # Payouts are created automatically after a payment has been successfully
+    # collected.
+    # Represents an instance of a payout resource returned from the API
+    class Payout
+      attr_reader :amount
+
+      attr_reader :created_at
+
+      attr_reader :currency
+
+      attr_reader :id
+
+      attr_reader :reference
+
+      attr_reader :status
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @amount = object['amount']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @id = object['id']
+        @links = object['links']
+        @reference = object['reference']
+        @status = object['status']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            creditor: '',
+
+            creditor_bank_account: ''
+
+          }.keys.sort
+        ).new(*@links.sort.map(&:last))
+      end
+
+      # Provides the resource as a hash of all it's readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -0,0 +1,106 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Redirect flows enable you to use GoCardless Pro's secure payment pages to
+    # set up mandates with your customers.
+    #
+    # The overall flow is:
+    #
+    #
+    # 1. You
+    # [create](https://developer.gocardless.com/pro/2015-04-29/#create-a-redirect-flow)
+    # a redirect flow for your customer, and redirect them to the returned
+    # redirect url, e.g. `https://pay.gocardless.com/flow/RE123`.
+    #
+    # 2. Your
+    # customer supplies their name, email, address, and bank account details, and
+    # submits the form. This securely stores their details, and redirects them
+    # back to your `success_redirect_url` with `redirect_flow_id=RE123` in the
+    # querystring.
+    #
+    # 3. You
+    # [complete](https://developer.gocardless.com/pro/2015-04-29/#complete-a-redirect-flow)
+    # the redirect flow, which creates a
+    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers),
+    # [customer bank
+    # account](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customer-bank-accounts),
+    # and
+    # [mandate](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-mandates),
+    # and returns the ID of the mandate. You may wish to create a
+    # [subscription](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-subscriptions)
+    # or
+    # [payment](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payments)
+    # at this point.
+    #
+    # It is recommended that you link the redirect flow to
+    # your user object as soon as it is created, and attach the created resources
+    # to that user in the complete step.
+    #
+    # Redirect flows expire 30 minutes
+    # after they are first created. You cannot
+    # [complete](https://developer.gocardless.com/pro/2015-04-29/#complete-a-redirect-flow)
+    # an expired redirect flow.
+    #
+    # [View an example
+    # integration](https://pay-sandbox.gocardless.com/AL000000AKFPFF) that uses
+    # redirect flows.
+    # Represents an instance of a redirect_flow resource returned from the API
+    class RedirectFlow
+      attr_reader :created_at
+
+      attr_reader :description
+
+      attr_reader :id
+
+      attr_reader :redirect_url
+
+      attr_reader :scheme
+
+      attr_reader :session_token
+
+      attr_reader :success_redirect_url
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @created_at = object['created_at']
+        @description = object['description']
+        @id = object['id']
+        @links = object['links']
+        @redirect_url = object['redirect_url']
+        @scheme = object['scheme']
+        @session_token = object['session_token']
+        @success_redirect_url = object['success_redirect_url']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            creditor: '',
+
+            mandate: ''
+
+          }.keys.sort
+        ).new(*@links.sort.map(&:last))
+      end
+
+      # Provides the resource as a hash of all it's readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end