gocardless_pro 1.0.5 → 1.1.0

data/lib/gocardless_pro/resources/subscription.rb

@@ -1,122 +1,109 @@
-
-
 # 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 subscription resource returned from the API
+
     # Subscriptions create [payments](#core-endpoints-payments) according to a
     # schedule.
     #
-    # #### Recurrence Rules
+    # ### Recurrence Rules
     #
-    # The following rules apply
-    # when specifying recurrence:
-    # - The first payment must be charged within 1
-    # year.
-    # - When neither `month` nor `day_of_month` are present, the
-    # subscription will recur from the `start_date` based on the `interval_unit`.
-
-    #  # - If `month` or `day_of_month` are present, the recurrence rules will be
-    # applied from the `start_date`, and the following validations apply:
+    # The following
+    # rules apply when specifying recurrence:
     #
+    # - The first payment
+    # must be charged within 1 year.
+    # - When neither `month` nor
+    # `day_of_month` are present, the subscription will recur from the
+    # `start_date` based on the `interval_unit`.
+    # - If `month` or
+    # `day_of_month` are present, the recurrence rules will be applied from the
+    # `start_date`, and the following validations apply:
     #
-    # | interval_unit   | month                                          |
+    # |
+    # interval_unit   | month                                          |
     # day_of_month                            |
     # | :-------------- |
     # :--------------------------------------------- |
     # :-------------------------------------- |
-    # | yearly          | optional
-    # (required if `day_of_month` provided) | optional (required if `month`
-    # provided) |
+    # | yearly          |
+    # optional (required if `day_of_month` provided) | optional (required if
+    # `month` provided) |
     # | monthly         | invalid
-    #       | required                                |
-    # | weekly          |
-    # invalid                                        | invalid
-    #             |
+    #                   | required                                |
+    # |
+    # weekly          | invalid                                        | invalid
+    #                                 |
     #
     # Examples:
     #
-    # | interval_unit   | interval   |
-    # month   | day_of_month   | valid?
-    #  |
-    # | :-------------- | :--------- | :------ | :------------- |
+    # |
+    # interval_unit   | interval   | month   | day_of_month   | valid?
+    #                                   |
+    # | :-------------- | :--------- |
+    # :------ | :------------- |
     # :------------------------------------------------- |
-    # | yearly          |
-    # 1          | january | -1             | valid
-    #               |
+    # | yearly
+    #   | 1          | january | -1             | valid
+    #                     |
     # | yearly          | 1          | march   |
-    #  | invalid - missing `day_of_month`                   |
-    # | monthly
-    #  | 6          |         | 12             | valid
-    #                  |
-    # | monthly         | 6          | august  | 12
-    #     | invalid - `month` must be blank                    |
+    #            | invalid - missing `day_of_month`                   |
+    # |
+    # monthly         | 6          |         | 12             | valid
+    #                                   |
+    # | monthly         | 6          |
+    # august  | 12             | invalid - `month` must be blank
+    #    |
+    # | weekly          | 2          |         |                |
+    # valid                                              |
     # | weekly
-    #     | 2          |         |                | valid
-    #                     |
-    # | weekly          | 2          | october | 10
-    #        | invalid - `month` and `day_of_month` must be blank |
+    #   | 2          | october | 10             | invalid - `month` and
+    # `day_of_month` must be blank |
+    #
+    # ### Rolling dates
     #
-    # ####
-    # Rolling dates
     #
-    # When a charge date falls on a non-business day, one
-    # of two things will happen:
+    # When a charge date falls on a non-business day, one of two things will
+    # happen:
     #
-    # - if the recurrence rule specified `-1`
-    # as the `day_of_month`, the charge date will be rolled __backwards__ to the
+    # - if the recurrence rule specified `-1` as the
+    # `day_of_month`, the charge date will be rolled __backwards__ to the
     # previous business day (i.e., the last working day of the month).
     # -
     # otherwise the charge date will be rolled __forwards__ to the next business
     # day.
     #
-    # Represents an instance of a subscription resource returned from the API
     class Subscription
       attr_reader :amount
-
-      attr_reader :count
-
       attr_reader :created_at
-
       attr_reader :currency
-
       attr_reader :day_of_month
-
       attr_reader :end_date
-
       attr_reader :id
-
       attr_reader :interval
-
       attr_reader :interval_unit
-
       attr_reader :metadata
-
       attr_reader :month
-
       attr_reader :name
-
       attr_reader :payment_reference
-
       attr_reader :start_date
-
       attr_reader :status
-
       attr_reader :upcoming_payments
-      # initialize a resource instance
+
+      # Initialize a subscription resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
         @object = object
 
         @amount = object['amount']
-        @count = object['count']
         @created_at = object['created_at']
         @currency = object['currency']
         @day_of_month = object['day_of_month']
@@ -139,31 +126,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(mandate )
-        valid_links = (@links || {}).select { |key, _| valid_link_keys.include?(key) }
-
-        links_class = Struct.new(
-          *{
-
-            mandate: ''
-
-          }.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 subscription resource as a hash of all its readable attributes
       def to_h
         @object
       end
+
+      class Links
+        def initialize(links)
+          @links = links
+        end
+
+        def mandate
+          @links['mandate']
+        end
+      end
     end
   end
 end

data/lib/gocardless_pro/services/bank_details_lookups_service.rb

@@ -1,10 +1,11 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
@@ -52,12 +53,12 @@ module GoCardlessPro
         'bank_details_lookups'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/creditor_bank_accounts_service.rb

@@ -1,10 +1,11 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
@@ -26,7 +27,7 @@ module GoCardlessPro
         Resources::CreditorBankAccount.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
       # creditor bank accounts.
       # Example URL: /creditor_bank_accounts
       # @param options [Hash] parameters as a hash, under a params key.
@@ -106,12 +107,12 @@ module GoCardlessPro
         'creditor_bank_accounts'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/creditors_service.rb

@@ -1,10 +1,11 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
@@ -26,7 +27,7 @@ module GoCardlessPro
         Resources::Creditor.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
       # creditors.
       # Example URL: /creditors
       # @param options [Hash] parameters as a hash, under a params key.
@@ -100,12 +101,12 @@ module GoCardlessPro
         'creditors'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/customer_bank_accounts_service.rb

@@ -1,10 +1,11 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
@@ -21,11 +22,11 @@ module GoCardlessPro
       # - IBAN
       #
       # - [Customer Bank
-      # Account Tokens](#js-flow-create-a-customer-bank-account-token)
+      # Account Tokens](#javascript-flow-create-a-customer-bank-account-token)
       #
-      # For more
-      # information on the different fields required in each country, see [local bank
-      # details](#appendix-local-bank-details).
+      #
+      # For more information on the different fields required in each country, see
+      # [local bank details](#appendix-local-bank-details).
       # Example URL: /customer_bank_accounts
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -41,7 +42,7 @@ module GoCardlessPro
         Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your bank
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your bank
       # accounts.
       # Example URL: /customer_bank_accounts
       # @param options [Hash] parameters as a hash, under a params key.
@@ -140,12 +141,12 @@ module GoCardlessPro
         'customer_bank_accounts'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/customers_service.rb

@@ -1,10 +1,11 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
@@ -26,7 +27,7 @@ module GoCardlessPro
         Resources::Customer.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
       # customers.
       # Example URL: /customers
       # @param options [Hash] parameters as a hash, under a params key.
@@ -100,12 +101,12 @@ module GoCardlessPro
         'customers'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/events_service.rb

@@ -1,16 +1,18 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
     # Service for making requests to the Event endpoints
     class EventsService < BaseService
-      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your events.
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
+      # events.
       # Example URL: /events
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -64,12 +66,12 @@ module GoCardlessPro
         'events'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/mandate_pdfs_service.rb

@@ -1,10 +1,11 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
@@ -51,12 +52,12 @@ module GoCardlessPro
         'mandate_pdfs'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/mandates_service.rb

@@ -1,10 +1,11 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
@@ -26,7 +27,7 @@ module GoCardlessPro
         Resources::Mandate.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
       # mandates.
       # Example URL: /mandates
       # @param options [Hash] parameters as a hash, under a params key.
@@ -151,12 +152,12 @@ module GoCardlessPro
         'mandates'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/payments_service.rb

@@ -1,10 +1,11 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
@@ -32,7 +33,7 @@ module GoCardlessPro
         Resources::Payment.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
       # payments.
       # Example URL: /payments
       # @param options [Hash] parameters as a hash, under a params key.
@@ -157,12 +158,12 @@ module GoCardlessPro
         'payments'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/payouts_service.rb

@@ -1,16 +1,17 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
     # Service for making requests to the Payout endpoints
     class PayoutsService < BaseService
-      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
       # payouts.
       # Example URL: /payouts
       # @param options [Hash] parameters as a hash, under a params key.
@@ -67,12 +68,12 @@ module GoCardlessPro
         'payouts'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end

data/lib/gocardless_pro/services/redirect_flows_service.rb

@@ -1,10 +1,11 @@
 require_relative './base_service'
+require 'uri'
 
 # encoding: utf-8
 #
-# WARNING: Do not edit by hand, this file was generated by Crank:
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
 #
-#   https://github.com/gocardless/crank
 
 module GoCardlessPro
   module Services
@@ -84,12 +85,12 @@ module GoCardlessPro
         'redirect_flows'
       end
 
-      # take a URL with placeholder params and substitute them out for the acutal value
+      # take a URL with placeholder params and substitute them out for the actual value
       # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
       def sub_url(url, param_map)
         param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", value)
+          new_url.gsub(":#{param}", URI.escape(value))
         end
       end
     end