gocardless_pro 0.3.0 → 1.0.0

data/lib/gocardless_pro/services/creditor_bank_accounts_service.rb

@@ -22,12 +22,11 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::CreditorBankAccount.new(unenvelope_body(response.body))
+        Resources::CreditorBankAccount.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your creditor bank accounts.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # creditor bank accounts.
       # Example URL: /creditor_bank_accounts
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -35,7 +34,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::CreditorBankAccount
         )
@@ -57,7 +56,7 @@ module GoCardlessPro
       # Retrieves the details of an existing creditor bank account.
       # Example URL: /creditor_bank_accounts/:identity
       #
-      # @param identity       # Unique identifier, beginning with "BA"
+      # @param identity       # Unique identifier, beginning with "BA".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/creditor_bank_accounts/:identity',           'identity' => identity)
@@ -65,7 +64,7 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::CreditorBankAccount.new(unenvelope_body(response.body))
+        Resources::CreditorBankAccount.new(unenvelope_body(response.body), response)
       end
 
       # Immediately disables the bank account, no money can be paid out to a disabled
@@ -78,7 +77,7 @@ module GoCardlessPro
       # creating a new bank account resource with the same details.
       # Example URL: /creditor_bank_accounts/:identity/actions/disable
       #
-      # @param identity       # Unique identifier, beginning with "BA"
+      # @param identity       # Unique identifier, beginning with "BA".
       # @param options [Hash] parameters as a hash, under a params key.
       def disable(identity, options = {})
         path = sub_url('/creditor_bank_accounts/:identity/actions/disable',           'identity' => identity)
@@ -89,7 +88,7 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::CreditorBankAccount.new(unenvelope_body(response.body))
+        Resources::CreditorBankAccount.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/creditors_service.rb

@@ -22,12 +22,11 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Creditor.new(unenvelope_body(response.body))
+        Resources::Creditor.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your creditors.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # creditors.
       # Example URL: /creditors
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -35,7 +34,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::Creditor
         )
@@ -65,7 +64,7 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::Creditor.new(unenvelope_body(response.body))
+        Resources::Creditor.new(unenvelope_body(response.body), response)
       end
 
       # Updates a creditor object. Supports all of the fields supported when creating
@@ -83,7 +82,7 @@ module GoCardlessPro
         response = make_request(:put, path, options)
 
         return if response.body.nil?
-        Resources::Creditor.new(unenvelope_body(response.body))
+        Resources::Creditor.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/customer_bank_accounts_service.rb

@@ -16,18 +16,16 @@ module GoCardlessPro
       # ways to supply bank account details:
       #
       # - [Local
-      # details](https://developer.gocardless.com/pro/2015-04-29/#ui-local-bank-details)
-      #
+      # details](#ui-local-bank-details)
       #
       # - IBAN
       #
       # - [Customer Bank Account
-      # Tokens](https://developer.gocardless.com/pro/2015-04-29/#js-flow-create-a-customer-bank-account-token)
-      #
+      # Tokens](#js-flow-create-a-customer-bank-account-token)
       #
-      # For more information on the different fields required in each country, see
-      # [local bank
-      # details](https://developer.gocardless.com/pro/2015-04-29/#ui-local-bank-details).
+      # For more
+      # information on the different fields required in each country, see [local bank
+      # details](#ui-local-bank-details).
       # Example URL: /customer_bank_accounts
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -39,12 +37,11 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::CustomerBankAccount.new(unenvelope_body(response.body))
+        Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your bank accounts.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your bank
+      # accounts.
       # Example URL: /customer_bank_accounts
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -52,7 +49,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::CustomerBankAccount
         )
@@ -74,7 +71,7 @@ module GoCardlessPro
       # Retrieves the details of an existing bank account.
       # Example URL: /customer_bank_accounts/:identity
       #
-      # @param identity       # Unique identifier, beginning with "BA"
+      # @param identity       # Unique identifier, beginning with "BA".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/customer_bank_accounts/:identity',           'identity' => identity)
@@ -82,14 +79,14 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::CustomerBankAccount.new(unenvelope_body(response.body))
+        Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
       end
 
       # Updates a customer bank account object. Only the metadata parameter is
       # allowed.
       # Example URL: /customer_bank_accounts/:identity
       #
-      # @param identity       # Unique identifier, beginning with "BA"
+      # @param identity       # Unique identifier, beginning with "BA".
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/customer_bank_accounts/:identity',           'identity' => identity)
@@ -100,7 +97,7 @@ module GoCardlessPro
         response = make_request(:put, path, options)
 
         return if response.body.nil?
-        Resources::CustomerBankAccount.new(unenvelope_body(response.body))
+        Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
       end
 
       # Immediately cancels all associated mandates and cancellable payments.
@@ -113,7 +110,7 @@ module GoCardlessPro
       # bank account resource with the same details.
       # Example URL: /customer_bank_accounts/:identity/actions/disable
       #
-      # @param identity       # Unique identifier, beginning with "BA"
+      # @param identity       # Unique identifier, beginning with "BA".
       # @param options [Hash] parameters as a hash, under a params key.
       def disable(identity, options = {})
         path = sub_url('/customer_bank_accounts/:identity/actions/disable',           'identity' => identity)
@@ -124,7 +121,7 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::CustomerBankAccount.new(unenvelope_body(response.body))
+        Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/customers_service.rb

@@ -22,12 +22,11 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Customer.new(unenvelope_body(response.body))
+        Resources::Customer.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your customers.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # customers.
       # Example URL: /customers
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -35,7 +34,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::Customer
         )
@@ -65,7 +64,7 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::Customer.new(unenvelope_body(response.body))
+        Resources::Customer.new(unenvelope_body(response.body), response)
       end
 
       # Updates a customer object. Supports all of the fields supported when creating
@@ -83,7 +82,7 @@ module GoCardlessPro
         response = make_request(:put, path, options)
 
         return if response.body.nil?
-        Resources::Customer.new(unenvelope_body(response.body))
+        Resources::Customer.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/events_service.rb

@@ -10,9 +10,7 @@ module GoCardlessPro
   module Services
     # Service for making requests to the Event endpoints
     class EventsService < BaseService
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your events.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your events.
       # Example URL: /events
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -20,7 +18,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::Event
         )
@@ -42,7 +40,7 @@ module GoCardlessPro
       # Retrieves the details of a single event.
       # Example URL: /events/:identity
       #
-      # @param identity       # Unique identifier, beginning with "EV"
+      # @param identity       # Unique identifier, beginning with "EV".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/events/:identity',           'identity' => identity)
@@ -50,7 +48,7 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::Event.new(unenvelope_body(response.body))
+        Resources::Event.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/mandate_pdfs_service.rb

@@ -0,0 +1,63 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+
+module GoCardlessPro
+  module Services
+    # Service for making requests to the MandatePdf endpoints
+    class MandatePdfsService < BaseService
+      # Generates a PDF mandate and returns its temporary URL.
+      #
+      # Customer and bank
+      # account details can be left blank (for a blank mandate), provided manually, or
+      # inferred from the ID of an existing [mandate](#core-endpoints-mandates).
+      #
+      #
+      # To generate a PDF mandate in a foreign language, set your `Accept-Language`
+      # header to the relevant [ISO
+      # 639-1](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes#Partial_ISO_639_table)
+      # language code. Supported languages are Dutch, English, French, German,
+      # Italian, Portuguese and Spanish.
+      # Example URL: /mandate_pdfs
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/mandate_pdfs'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::MandatePdf.new(unenvelope_body(response.body), response)
+      end
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      private
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'mandate_pdfs'
+      end
+
+      # take a URL with placeholder params and substitute them out for the acutal value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", value)
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/mandates_service.rb

@@ -22,13 +22,11 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Mandate.new(unenvelope_body(response.body))
+        Resources::Mandate.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your mandates. Except where stated, these filters can only be used one
-      # at a time.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # mandates. Except where stated, these filters can only be used one at a time.
       # Example URL: /mandates
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -36,7 +34,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::Mandate
         )
@@ -56,19 +54,9 @@ module GoCardlessPro
       end
 
       # Retrieves the details of an existing mandate.
-      #
-      # If you specify `Accept:
-      # application/pdf` on a request to this endpoint it will return a PDF complying
-      # to the relevant scheme rules, which you can present to your customer.
-      #
-      # PDF
-      # mandates can be retrieved in Dutch, English, French, German, Italian,
-      # Portuguese and Spanish by specifying the [ISO
-      # 639-1](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes#Partial_ISO_639_table)
-      # language code as an `Accept-Language` header.
       # Example URL: /mandates/:identity
       #
-      # @param identity       # Unique identifier, beginning with "MD"
+      # @param identity       # Unique identifier, beginning with "MD".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/mandates/:identity',           'identity' => identity)
@@ -76,13 +64,13 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::Mandate.new(unenvelope_body(response.body))
+        Resources::Mandate.new(unenvelope_body(response.body), response)
       end
 
       # Updates a mandate object. This accepts only the metadata parameter.
       # Example URL: /mandates/:identity
       #
-      # @param identity       # Unique identifier, beginning with "MD"
+      # @param identity       # Unique identifier, beginning with "MD".
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/mandates/:identity',           'identity' => identity)
@@ -93,7 +81,7 @@ module GoCardlessPro
         response = make_request(:put, path, options)
 
         return if response.body.nil?
-        Resources::Mandate.new(unenvelope_body(response.body))
+        Resources::Mandate.new(unenvelope_body(response.body), response)
       end
 
       # Immediately cancels a mandate and all associated cancellable payments. Any
@@ -104,7 +92,7 @@ module GoCardlessPro
       # mandate is already cancelled.
       # Example URL: /mandates/:identity/actions/cancel
       #
-      # @param identity       # Unique identifier, beginning with "MD"
+      # @param identity       # Unique identifier, beginning with "MD".
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/mandates/:identity/actions/cancel',           'identity' => identity)
@@ -115,7 +103,7 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Mandate.new(unenvelope_body(response.body))
+        Resources::Mandate.new(unenvelope_body(response.body), response)
       end
 
       # <a name="mandate_not_inactive"></a>Reinstates a cancelled or expired mandate
@@ -132,7 +120,7 @@ module GoCardlessPro
       # Mandates can be resubmitted up to 3 times.
       # Example URL: /mandates/:identity/actions/reinstate
       #
-      # @param identity       # Unique identifier, beginning with "MD"
+      # @param identity       # Unique identifier, beginning with "MD".
       # @param options [Hash] parameters as a hash, under a params key.
       def reinstate(identity, options = {})
         path = sub_url('/mandates/:identity/actions/reinstate',           'identity' => identity)
@@ -143,7 +131,7 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Mandate.new(unenvelope_body(response.body))
+        Resources::Mandate.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`