gocardless_pro 1.0.5 → 1.1.0

data/lib/gocardless_pro/resources/mandate.rb

@@ -1,39 +1,33 @@
-
-
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
-#
-#   https://github.com/gocardless/crank
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
+
 require 'uri'
 
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
+    # Represents an instance of a mandate resource returned from the API
+
     # Mandates represent the Direct Debit mandate with a
     # [customer](#core-endpoints-customers).
     #
-    # GoCardless will notify you
-    # via a [webhook](#webhooks) whenever the status of a mandate changes.
-    # Represents an instance of a mandate resource returned from the API
+    # GoCardless will notify
+    # you via a [webhook](#appendix-webhooks) whenever the status of a mandate
+    # changes.
     class Mandate
       attr_reader :created_at
-
       attr_reader :id
-
       attr_reader :metadata
-
       attr_reader :next_possible_charge_date
-
       attr_reader :payments_require_approval
-
       attr_reader :reference
-
       attr_reader :scheme
-
       attr_reader :status
-      # initialize a resource instance
+
+      # Initialize a mandate resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -54,32 +48,36 @@ module GoCardlessPro
         ApiResponse.new(@response)
       end
 
-      # return the links that the resource has
+      # Return the links that the resource has
       def links
-        valid_link_keys = %w(creditor customer_bank_account )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
+        @links_links ||= Links.new(@links)
+      end
 
-        links_class = Struct.new(
-          *{
+      # Provides the mandate resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
 
-            creditor: '',
+      class Links
+        def initialize(links)
+          @links = links
+        end
 
-            customer_bank_account: ''
+        def creditor
+          @links['creditor']
+        end
 
-          }.keys
-        ) do
-          def initialize(hash)
-            hash.each do |key, val|
-              send("#{key}=", val)
-            end
-          end
+        def customer
+          @links['customer']
         end
-        links_class.new(valid_links)
-      end
 
-      # Provides the resource as a hash of all it's readable attributes
-      def to_h
-        @object
+        def customer_bank_account
+          @links['customer_bank_account']
+        end
+
+        def new_mandate
+          @links['new_mandate']
+        end
       end
     end
   end

data/lib/gocardless_pro/resources/mandate_pdf.rb

@@ -1,25 +1,24 @@
-
-
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
-#
-#   https://github.com/gocardless/crank
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
+
 require 'uri'
 
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
-    # Mandate PDFs allow you to easily display [scheme-rules
-    # compliant](#appendix-compliance-requirements) Direct Debit mandates to your
-    # customers.
     # Represents an instance of a mandate_pdf resource returned from the API
+
+    # Mandate PDFs allow you to easily display [scheme-rules
+    # compliant](#appendix-compliance-requirements) Direct Debit mandates to
+    # your customers.
     class MandatePdf
       attr_reader :expires_at
-
       attr_reader :url
-      # initialize a resource instance
+
+      # Initialize a mandate_pdf resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -33,7 +32,7 @@ module GoCardlessPro
         ApiResponse.new(@response)
       end
 
-      # Provides the resource as a hash of all it's readable attributes
+      # Provides the mandate_pdf resource as a hash of all its readable attributes
       def to_h
         @object
       end

data/lib/gocardless_pro/resources/payment.rb

@@ -1,45 +1,37 @@
-
-
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
-#
-#   https://github.com/gocardless/crank
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
+
 require 'uri'
 
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
+    # Represents an instance of a payment resource returned from the API
+
     # Payment objects represent payments from a
     # [customer](#core-endpoints-customers) to a
-    # [creditor](#whitelabel-partner-endpoints-creditors), taken against a Direct
-    # Debit [mandate](#core-endpoints-mandates).
+    # [creditor](#whitelabel-partner-endpoints-creditors), taken against a
+    # Direct Debit [mandate](#core-endpoints-mandates).
     #
-    # GoCardless will notify
-    # you via a [webhook](#webhooks) whenever the state of a payment changes.
-    # Represents an instance of a payment resource returned from the API
+    # GoCardless
+    # will notify you via a [webhook](#appendix-webhooks) whenever the state of
+    # a payment changes.
     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
+
+      # Initialize a payment resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -62,36 +54,36 @@ module GoCardlessPro
         ApiResponse.new(@response)
       end
 
-      # return the links that the resource has
+      # Return the links that the resource has
       def links
-        valid_link_keys = %w(creditor mandate payout subscription )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
-
-        links_class = Struct.new(
-          *{
+        @links_links ||= Links.new(@links)
+      end
 
-            creditor: '',
+      # Provides the payment resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
 
-            mandate: '',
+      class Links
+        def initialize(links)
+          @links = links
+        end
 
-            payout: '',
+        def creditor
+          @links['creditor']
+        end
 
-            subscription: ''
+        def mandate
+          @links['mandate']
+        end
 
-          }.keys
-        ) do
-          def initialize(hash)
-            hash.each do |key, val|
-              send("#{key}=", val)
-            end
-          end
+        def payout
+          @links['payout']
         end
-        links_class.new(valid_links)
-      end
 
-      # Provides the resource as a hash of all it's readable attributes
-      def to_h
-        @object
+        def subscription
+          @links['subscription']
+        end
       end
     end
   end

data/lib/gocardless_pro/resources/payout.rb

@@ -1,39 +1,32 @@
-
-
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
-#
-#   https://github.com/gocardless/crank
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
+
 require 'uri'
 
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
+    # Represents an instance of a payout resource returned from the API
+
     # Payouts represent transfers from GoCardless to a
     # [creditor](#whitelabel-partner-endpoints-creditors). Each payout contains
     # the funds collected from one or many [payments](#core-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 :arrival_date
-
       attr_reader :created_at
-
       attr_reader :currency
-
       attr_reader :deducted_fees
-
       attr_reader :id
-
       attr_reader :reference
-
       attr_reader :status
-      # initialize a resource instance
+
+      # Initialize a payout resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -54,32 +47,28 @@ module GoCardlessPro
         ApiResponse.new(@response)
       end
 
-      # return the links that the resource has
+      # Return the links that the resource has
       def links
-        valid_link_keys = %w(creditor creditor_bank_account )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
-
-        links_class = Struct.new(
-          *{
+        @links_links ||= Links.new(@links)
+      end
 
-            creditor: '',
+      # Provides the payout resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
 
-            creditor_bank_account: ''
+      class Links
+        def initialize(links)
+          @links = links
+        end
 
-          }.keys
-        ) do
-          def initialize(hash)
-            hash.each do |key, val|
-              send("#{key}=", val)
-            end
-          end
+        def creditor
+          @links['creditor']
         end
-        links_class.new(valid_links)
-      end
 
-      # Provides the resource as a hash of all it's readable attributes
-      def to_h
-        @object
+        def creditor_bank_account
+          @links['creditor_bank_account']
+        end
       end
     end
   end

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -1,65 +1,60 @@
-
-
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
-#
-#   https://github.com/gocardless/crank
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
+
 require 'uri'
 
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
+    # Represents an instance of a redirect_flow resource returned from the API
+
     # Redirect flows enable you to use GoCardless' [hosted payment
-    # pages](https://pay-sandbox.gocardless.com/AL000000AKFPFF) to set up mandates
-    # with your customers. These pages are fully compliant and have been
-    # translated into Dutch, French, German, Italian, Portuguese, Spanish and
-    # Swedish.
+    # pages](https://pay-sandbox.gocardless.com/AL000000AKFPFF) to set up
+    # mandates with your customers. These pages are fully compliant and have
+    # been translated into Dutch, French, German, Italian, Portuguese, Spanish
+    # and Swedish.
     #
     # The overall flow is:
     #
     # 1. You
-    # [create](#create-a-redirect-flow) a redirect flow for your customer, and
-    # redirect them to the returned redirect url, e.g.
+    # [create](#redirect-flows-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.
-    #
+    # 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](#complete-a-redirect-flow) the redirect flow, which
-    # creates a [customer](#core-endpoints-customers), [customer bank
+    # 3. You
+    # [complete](#redirect-flows-complete-a-redirect-flow) the redirect flow,
+    # which creates a [customer](#core-endpoints-customers), [customer bank
     # account](#core-endpoints-customer-bank-accounts), and
-    # [mandate](#core-endpoints-mandates), and returns the ID of the mandate. You
-    # may wish to create a [subscription](#core-endpoints-subscriptions) or
+    # [mandate](#core-endpoints-mandates), and returns the ID of the mandate.
+    # You may wish to create a [subscription](#core-endpoints-subscriptions) or
     # [payment](#core-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.
+    # 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 an expired redirect flow.
-    # Represents an instance of a redirect_flow resource returned from the API
+    # Redirect flows expire 30 minutes after they
+    # are first created. You cannot complete an expired redirect flow.
     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
+
+      # Initialize a redirect_flow resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -79,36 +74,36 @@ module GoCardlessPro
         ApiResponse.new(@response)
       end
 
-      # return the links that the resource has
+      # Return the links that the resource has
       def links
-        valid_link_keys = %w(creditor customer customer_bank_account mandate )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
-
-        links_class = Struct.new(
-          *{
+        @links_links ||= Links.new(@links)
+      end
 
-            creditor: '',
+      # Provides the redirect_flow resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
 
-            customer: '',
+      class Links
+        def initialize(links)
+          @links = links
+        end
 
-            customer_bank_account: '',
+        def creditor
+          @links['creditor']
+        end
 
-            mandate: ''
+        def customer
+          @links['customer']
+        end
 
-          }.keys
-        ) do
-          def initialize(hash)
-            hash.each do |key, val|
-              send("#{key}=", val)
-            end
-          end
+        def customer_bank_account
+          @links['customer_bank_account']
         end
-        links_class.new(valid_links)
-      end
 
-      # Provides the resource as a hash of all it's readable attributes
-      def to_h
-        @object
+        def mandate
+          @links['mandate']
+        end
       end
     end
   end

data/lib/gocardless_pro/resources/refund.rb

@@ -1,41 +1,32 @@
-
-
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
-#
-#   https://github.com/gocardless/crank
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
+
 require 'uri'
 
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
+    # Represents an instance of a refund resource returned from the API
+
     # Refund objects represent (partial) refunds of a
-    # [payment](#core-endpoints-payment) back to the
+    # [payment](#core-endpoints-payments) back to the
     # [customer](#core-endpoints-customers).
     #
-    # GoCardless will notify you
-    # via a [webhook](#webhooks) whenever a refund is created, and will update the
-    # `amount_refunded` property of the payment.
-    #
-    # _Note:_ A payment that
-    # has been (partially) refunded can still receive a late failure or chargeback
-    # from the banks.
-    # Represents an instance of a refund resource returned from the API
+    # GoCardless will notify
+    # you via a [webhook](#appendix-webhooks) whenever a refund is created, and
+    # will update the `amount_refunded` property of the payment.
     class Refund
       attr_reader :amount
-
       attr_reader :created_at
-
       attr_reader :currency
-
       attr_reader :id
-
       attr_reader :metadata
-
       attr_reader :reference
-      # initialize a resource instance
+
+      # Initialize a refund resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -54,31 +45,25 @@ module GoCardlessPro
         ApiResponse.new(@response)
       end
 
-      # return the links that the resource has
+      # Return the links that the resource has
       def links
-        valid_link_keys = %w(payment )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
-
-        links_class = Struct.new(
-          *{
-
-            payment: ''
-
-          }.keys
-        ) do
-          def initialize(hash)
-            hash.each do |key, val|
-              send("#{key}=", val)
-            end
-          end
-        end
-        links_class.new(valid_links)
+        @links_links ||= Links.new(@links)
       end
 
-      # Provides the resource as a hash of all it's readable attributes
+      # Provides the refund resource as a hash of all its readable attributes
       def to_h
         @object
       end
+
+      class Links
+        def initialize(links)
+          @links = links
+        end
+
+        def payment
+          @links['payment']
+        end
+      end
     end
   end
 end