gocardless-pro 0.1.0

data/lib/gocardless-pro/resources/publishable_api_key.rb

@@ -0,0 +1,51 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardless
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Publishable API keys are designed to be used by the [js
+    # flow](https://developer.gocardless.com/pro/#api-endpoints-customer-bank-account-tokens).
+    # You should generate a key and then use it to make requests to the API. They
+    # do not expire, but can be disabled.
+    #
+    # Publishable API keys only have
+    # permissions to create [customer bank account
+    # tokens](https://developer.gocardless.com/pro/#api-endpoints-customer-bank-account-tokens).
+    # Represents an instance of a publishable_api_key resource returned from the API
+    class PublishableApiKey
+      attr_reader :created_at
+
+      attr_reader :enabled
+
+      attr_reader :id
+
+      attr_reader :key
+
+      attr_reader :name
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @created_at = object['created_at']
+        @enabled = object['enabled']
+        @id = object['id']
+        @key = object['key']
+        @name = object['name']
+      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,104 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardless
+  # 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/#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/#complete-a-redirect-flow)
+    # the redirect flow, which creates a
+    # [customer](https://developer.gocardless.com/pro/#api-endpoints-customers),
+    # [customer bank
+    # account](https://developer.gocardless.com/pro/#api-endpoints-customer-bank-accounts),
+    # and [mandate](https://developer.gocardless.com/pro/#api-endpoints-mandates),
+    # and returns the ID of the mandate. You may wish to create a
+    # [subscription](https://developer.gocardless.com/pro/#api-endpoints-subscriptions)
+    # or [payment](https://developer.gocardless.com/pro/#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/#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

data/lib/gocardless-pro/resources/refund.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 GoCardless
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Refund objects represent (partial) refunds of a
+    # [payment](https://developer.gocardless.com/pro/#api-endpoints-payment) back
+    # to the
+    # [customer](https://developer.gocardless.com/pro/#api-endpoints-customers).
+
+    # #
+    # The API allows you to create, show, list and update your refunds.
+    #
+    #
+    # GoCardless will notify you via a
+    # [webhook](https://developer.gocardless.com/pro/#webhooks) whenever a refund
+    # is created.
+    #
+    # _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
+    class Refund
+      attr_reader :amount
+
+      attr_reader :created_at
+
+      attr_reader :currency
+
+      attr_reader :id
+
+      attr_reader :metadata
+      # 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']
+        @metadata = object['metadata']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            payment: ''
+
+          }.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/role.rb

@@ -0,0 +1,101 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardless
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # <a name="insufficient_permissions"></a>Roles represent a set of permissions
+    # that may be granted to a user. The permissions are specified at the
+    # resource-type level, and can be `full_access` or `read_only`. If a
+    # resource-type is not included that role's users will have no access to
+    # resources of that type, and will receive an `insufficient_permissions` error
+    # when trying to use those endpoints.
+    #
+    # A role's `permissions`
+    # attribute is used to set/show the permissions for a role and it's key/value
+    # pairs are restricted to the below:
+    #
+    # <dl>
+    #
+    # <dt><p><code>resource</code></p></dt>
+    #   <dd><p>One of:</p>
+    #     <ul>
+
+    #  #       <li><code>customers</code></li>
+    #
+    # <li><code>customer_bank_accounts</code></li>
+    #
+    # <li><code>mandates</code></li>
+    #       <li><code>payments</code></li>
+    #
+    #      <li><code>payouts</code></li>
+    #
+    # <li><code>creditors</code></li>
+    #
+    # <li><code>creditor_bank_accounts</code></li>
+    #
+    # <li><code>roles</code></li>
+    #       <li><code>users</code></li>
+    #
+    # <li><code>events</code></li>
+    #       <li><code>api_keys</code></li>
+    #
+    #    <li><code>subscriptions</code></li>
+    #
+    # <li><code>redirect_flows</code></li>
+    #     </ul>
+    #   </dd>
+    # </dl>
+    #
+    #
+    # <dl>
+    #   <dt><p><code>access</code></p></dt>
+    #   <dd><p>One
+    # of:</p>
+    #     <ul>
+    #       <li><code>full_access</code>: read and write
+    # all records of this type</li>
+    #       <li><code>read_only</code>: list and
+    # show endpoints available, but not create, update, delete, or actions</li>
+
+    # #     </ul>
+    #   </dd>
+    # </dl>
+    #
+    # Represents an instance of a role resource returned from the API
+    class Role
+      attr_reader :created_at
+
+      attr_reader :enabled
+
+      attr_reader :id
+
+      attr_reader :name
+
+      attr_reader :permissions
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @created_at = object['created_at']
+        @enabled = object['enabled']
+        @id = object['id']
+        @name = object['name']
+        @permissions = object['permissions']
+      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/subscription.rb

@@ -0,0 +1,152 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardless
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Subscriptions create
+    # [payments](https://developer.gocardless.com/pro/#api-endpoints-payments)
+    # according to a schedule.
+    #
+    # #### 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_at` based on the
+    # `interval_unit`.
+    # - If `month` or `day_of_month` are present, the
+    # recurrence rules will be applied from the `start_at`, and the following
+    # validations apply:
+    #
+    # | interval_unit   | month
+    #                   | day_of_month                            |
+    # |
+    # :-------------- | :--------------------------------------------- |
+    # :-------------------------------------- |
+    # | yearly          | optional
+    # (required if `day_of_month` provided) | optional (required if `month`
+    # provided) |
+    # | monthly         | invalid
+    #       | required                                |
+    # | weekly          |
+    # invalid                                        | invalid
+    #             |
+    #
+    # Examples:
+    #
+    # | interval_unit   | interval   |
+    # month   | day_of_month   | 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                    |
+    # | weekly
+    #     | 2          |         |                | valid
+    #                     |
+    # | weekly          | 2          | october | 10
+    #        | invalid - `month` and `day_of_month` must be blank |
+    #
+    # ####
+    # Rolling dates
+    #
+    # 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
+    # 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_at
+
+      attr_reader :id
+
+      attr_reader :interval
+
+      attr_reader :interval_unit
+
+      attr_reader :metadata
+
+      attr_reader :month
+
+      attr_reader :name
+
+      attr_reader :start_at
+
+      attr_reader :status
+
+      attr_reader :upcoming_payments
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @amount = object['amount']
+        @count = object['count']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @day_of_month = object['day_of_month']
+        @end_at = object['end_at']
+        @id = object['id']
+        @interval = object['interval']
+        @interval_unit = object['interval_unit']
+        @links = object['links']
+        @metadata = object['metadata']
+        @month = object['month']
+        @name = object['name']
+        @start_at = object['start_at']
+        @status = object['status']
+        @upcoming_payments = object['upcoming_payments']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            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