gocardless_pro 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25c17c94e9c95d89c64ef541cba1ad27a4161034
-  data.tar.gz: f3e4363abacd1fd9762b6e93dc1f1a9be5108a11
+  metadata.gz: f9bf930f0861c969e5518b00a10e9751691b4505
+  data.tar.gz: 3ca0cd94ef9b840cacf9e5aa3ddd7fb843404ed3
 SHA512:
-  metadata.gz: 25a5a1693d92817de49cd708ae348c0c86833fae5838c4691c877fbb298ca5c5e023671cdd5dbb4d0f374329837fc5d4273205ef2c380ce77192737771059265
-  data.tar.gz: b4ad5c3055093b64930ca5612940f75ad0f8db82c153a3b8e8b58680f08e379c8880f381f11dab061e914ae0d2276bf8a9ee18a3806bf6fb0b1edd2c0e30aae1
+  metadata.gz: a86b8b85b3e57c6b199d8dbea5591bb3a393f339e2e506a939a82a2bdc22cb8df5361f1f4e4288604b29d3debdfde3b2a7ebb1d8895c640a456e4d795c3b5477
+  data.tar.gz: 2bf60b407e6fdc07d2e582274197bff176b03f9fc4d30f25591943ab0479121ab9ea388c56c931d0bfe6d14aa5276d1e7e983faaa06fd212ed900ca84d83e4b3

data/README.md

@@ -5,11 +5,13 @@ A Ruby client for the GoCardless API. For full details of the GoCardless API, se
 [![Gem Version](https://badge.fury.io/rb/statesman.png)](http://badge.fury.io/rb/gocardless_pro)
 [![Build Status](https://travis-ci.org/gocardless/gocardless-pro-ruby.svg?branch=master)](https://travis-ci.org/gocardless/gocardless-pro-ruby)
 
+- ["Getting started" guide](https://developer.gocardless.com/getting-started/api/introduction/?lang=ruby) with copy and paste Ruby code samples
+- [API Reference](https://developer.gocardless.com/api-reference/2015-07-06)
 
 ## Usage Examples
 
 This README will use `customers` throughout but each of the resources in the
-[API](https://developer.gocardless.com/pro/) is available in this library.
+[API](https://developer.gocardless.com/api-reference/) is available in this library.
 
 ### Installation
 
@@ -147,7 +149,7 @@ When the API returns an error, the client will raise a corresponding one. There
 - `GoCardlessPro::InvalidStateError`
 - `GoCardlessPro::ValidationError`
 
-These errors are fully documented in the [API documentation](https://developer.gocardless.com/pro/#overview-errors).
+These errors are fully documented in the [API documentation](https://developer.gocardless.com/api-reference/#overview-errors).
 
 All errors have the following methods to facilitate access to information in the API response:
 

data/lib/gocardless_pro/api_service.rb

@@ -1,9 +1,9 @@
 # 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'
 require 'base64'
 

data/lib/gocardless_pro/resources/bank_details_lookup.rb

@@ -1,25 +1,23 @@
-
-
 # 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
-    # Look up the name and reachability of a bank.
     # Represents an instance of a bank_details_lookup resource returned from the API
+
+    # Look up the name and reachability of a bank.
     class BankDetailsLookup
       attr_reader :available_debit_schemes
-
       attr_reader :bank_name
-
       attr_reader :bic
-      # initialize a resource instance
+
+      # Initialize a bank_details_lookup resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -34,7 +32,7 @@ module GoCardlessPro
         ApiResponse.new(@response)
       end
 
-      # Provides the resource as a hash of all it's readable attributes
+      # Provides the bank_details_lookup resource as a hash of all its readable attributes
       def to_h
         @object
       end

data/lib/gocardless_pro/resources/creditor.rb

@@ -1,46 +1,40 @@
-
-
 # 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
-    # Each [payment](#core-endpoints-payments) taken through the API is linked to
-    # a "creditor", to whom the payment is then paid out. In most cases your
+    # Represents an instance of a creditor resource returned from the API
+
+    # Each [payment](#core-endpoints-payments) taken through the API is linked
+    # to a "creditor", to whom the payment is then paid out. In most cases your
     # organisation will have a single "creditor", but the API also supports
     # collecting payments on behalf of others.
     #
-    # Please get in touch if you
-    # wish to use this endpoint. Currently, for Anti Money Laundering reasons, any
-    # creditors you add must be directly related to your organisation.
-    # Represents an instance of a creditor resource returned from the API
+    # Please get in touch
+    # if you wish to use this endpoint. Currently, for Anti Money Laundering
+    # reasons, any creditors you add must be directly related to your
+    # organisation.
     class Creditor
       attr_reader :address_line1
-
       attr_reader :address_line2
-
       attr_reader :address_line3
-
       attr_reader :city
-
       attr_reader :country_code
-
       attr_reader :created_at
-
       attr_reader :id
-
+      attr_reader :logo_url
       attr_reader :name
-
       attr_reader :postal_code
-
       attr_reader :region
-      # initialize a resource instance
+      attr_reader :scheme_identifiers
+
+      # Initialize a creditor resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -53,9 +47,11 @@ module GoCardlessPro
         @created_at = object['created_at']
         @id = object['id']
         @links = object['links']
+        @logo_url = object['logo_url']
         @name = object['name']
         @postal_code = object['postal_code']
         @region = object['region']
+        @scheme_identifiers = object['scheme_identifiers']
         @response = response
       end
 
@@ -63,34 +59,32 @@ 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(default_eur_payout_account default_gbp_payout_account default_sek_payout_account )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
-
-        links_class = Struct.new(
-          *{
+        @links_links ||= Links.new(@links)
+      end
 
-            default_eur_payout_account: '',
+      # Provides the creditor resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
 
-            default_gbp_payout_account: '',
+      class Links
+        def initialize(links)
+          @links = links
+        end
 
-            default_sek_payout_account: ''
+        def default_eur_payout_account
+          @links['default_eur_payout_account']
+        end
 
-          }.keys
-        ) do
-          def initialize(hash)
-            hash.each do |key, val|
-              send("#{key}=", val)
-            end
-          end
+        def default_gbp_payout_account
+          @links['default_gbp_payout_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 default_sek_payout_account
+          @links['default_sek_payout_account']
+        end
       end
     end
   end

data/lib/gocardless_pro/resources/creditor_bank_account.rb

@@ -1,46 +1,38 @@
-
-
 # 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 creditor_bank_account resource returned from the API
+
     # Creditor Bank Accounts hold the bank details of a
     # [creditor](#whitelabel-partner-endpoints-creditors). These are the bank
     # accounts which your [payouts](#core-endpoints-payouts) will be sent to.
-    #
-    #
+
+    #  #
     # Note that creditor 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[creditor_bank_account]`
-    # in the error response.
-    # Represents an instance of a creditor_bank_account resource returned from the API
+    # instead, the ID of which will be provided as
+    # `links[creditor_bank_account]` in the error response.
     class CreditorBankAccount
       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
+
+      # Initialize a creditor_bank_account resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -62,31 +54,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(creditor )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
-
-        links_class = Struct.new(
-          *{
-
-            creditor: ''
-
-          }.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 creditor_bank_account resource as a hash of all its readable attributes
       def to_h
         @object
       end
+
+      class Links
+        def initialize(links)
+          @links = links
+        end
+
+        def creditor
+          @links['creditor']
+        end
+      end
     end
   end
 end

data/lib/gocardless_pro/resources/customer.rb

@@ -1,59 +1,44 @@
-
-
 # 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 customer resource returned from the API
+
     # Customer objects hold the contact details for a customer. A customer can
     # have several [customer bank
     # accounts](#core-endpoints-customer-bank-accounts), which in turn can have
     # several Direct Debit [mandates](#core-endpoints-mandates).
     #
-    # Note:
-    # the `swedish_identity_number` field may only be supplied for Swedish
-    # customers, and must be supplied if you intend to set up an Autogiro mandate
-    # with the customer.
-    # Represents an instance of a customer resource returned from the API
+    #
+    # Note: the `swedish_identity_number` field may only be supplied for Swedish
+    # customers, and must be supplied if you intend to set up an Autogiro
+    # mandate with the customer.
     class Customer
       attr_reader :address_line1
-
       attr_reader :address_line2
-
       attr_reader :address_line3
-
       attr_reader :city
-
       attr_reader :company_name
-
       attr_reader :country_code
-
       attr_reader :created_at
-
       attr_reader :email
-
       attr_reader :family_name
-
       attr_reader :given_name
-
       attr_reader :id
-
       attr_reader :language
-
       attr_reader :metadata
-
       attr_reader :postal_code
-
       attr_reader :region
-
       attr_reader :swedish_identity_number
-      # initialize a resource instance
+
+      # Initialize a customer resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -81,7 +66,7 @@ module GoCardlessPro
         ApiResponse.new(@response)
       end
 
-      # Provides the resource as a hash of all it's readable attributes
+      # Provides the customer resource as a hash of all its readable attributes
       def to_h
         @object
       end

data/lib/gocardless_pro/resources/customer_bank_account.rb

@@ -1,46 +1,39 @@
-
-
 # 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 customer_bank_account resource returned from the API
+
     # Customer Bank Accounts hold the bank details of a
     # [customer](#core-endpoints-customers). They always belong to a
     # [customer](#core-endpoints-customers), and may be linked to several Direct
     # Debit [mandates](#core-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
+    # 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.
     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
+
+      # Initialize a customer_bank_account resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -62,31 +55,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(customer )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
-
-        links_class = Struct.new(
-          *{
-
-            customer: ''
-
-          }.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 customer_bank_account resource as a hash of all its readable attributes
       def to_h
         @object
       end
+
+      class Links
+        def initialize(links)
+          @links = links
+        end
+
+        def customer
+          @links['customer']
+        end
+      end
     end
   end
 end

data/lib/gocardless_pro/resources/event.rb

@@ -1,33 +1,28 @@
-
-
 # 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
-    # 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
+
+    # 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.
     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
+
+      # Initialize a event resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
@@ -46,46 +41,60 @@ 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(mandate new_customer_bank_account organisation parent_event payment payout previous_customer_bank_account refund subscription )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
+        @links_links ||= Links.new(@links)
+      end
 
-        links_class = Struct.new(
-          *{
+      # Provides the event resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
 
-            mandate: '',
+      class Links
+        def initialize(links)
+          @links = links
+        end
 
-            new_customer_bank_account: '',
+        def mandate
+          @links['mandate']
+        end
 
-            organisation: '',
+        def new_customer_bank_account
+          @links['new_customer_bank_account']
+        end
 
-            parent_event: '',
+        def new_mandate
+          @links['new_mandate']
+        end
 
-            payment: '',
+        def organisation
+          @links['organisation']
+        end
 
-            payout: '',
+        def parent_event
+          @links['parent_event']
+        end
 
-            previous_customer_bank_account: '',
+        def payment
+          @links['payment']
+        end
 
-            refund: '',
+        def payout
+          @links['payout']
+        end
 
-            subscription: ''
+        def previous_customer_bank_account
+          @links['previous_customer_bank_account']
+        end
 
-          }.keys
-        ) do
-          def initialize(hash)
-            hash.each do |key, val|
-              send("#{key}=", val)
-            end
-          end
+        def refund
+          @links['refund']
         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