gocardless-pro 0.1.0

data/lib/gocardless-pro/services/refund_service.rb

@@ -0,0 +1,126 @@
+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 GoCardless
+  module Services
+    # Service for making requests to the Refund endpoints
+    class RefundService < BaseService
+      # Creates a new refund object.
+      #
+      # This fails with:<a
+      # name="refund_payment_invalid_state"></a><a
+      # name="total_amount_confirmation_invalid"></a>
+      #
+      # -
+      # `refund_payment_invalid_state` error if the linked
+      # [payment](https://developer.gocardless.com/pro/#api-endpoints-payments) isn't
+      # either `confirmed` or `paid_out`.
+      #
+      # - `total_amount_confirmation_invalid`
+      # if the confirmation amount doesn't match the total amount refunded for the
+      # payment. This safeguard is there to prevent two processes from creating
+      # refunds without awareness of each other.
+      #
+      # Example URL: /refunds
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/refunds'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::Refund.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
+      # list of your refunds.
+      # Example URL: /refunds
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/refunds'
+
+        response = make_request(:get, path, options, custom_headers)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Refund
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          path: '/refunds',
+          options: options
+        ).enumerator
+      end
+
+      # Retrieves all details for a single refund
+      # Example URL: /refunds/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "RF"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/refunds/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::Refund.new(unenvelope_body(response.body))
+      end
+
+      # Updates a refund object.
+      # Example URL: /refunds/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "RF"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def update(identity, options = {}, custom_headers = {})
+        path = sub_url('/refunds/:identity',           'identity' => identity)
+
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:put, path, options, custom_headers)
+
+        Resources::Refund.new(unenvelope_body(response.body))
+      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
+        'refunds'
+      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/role_service.rb

@@ -0,0 +1,127 @@
+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 GoCardless
+  module Services
+    # Service for making requests to the Role endpoints
+    class RoleService < BaseService
+      # Create a role with set access permissions
+      # Example URL: /roles
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/roles'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::Role.new(unenvelope_body(response.body))
+      end
+
+      # List all existing roles
+      # Example URL: /roles
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/roles'
+
+        response = make_request(:get, path, options, custom_headers)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Role
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          path: '/roles',
+          options: options
+        ).enumerator
+      end
+
+      # Retrieve all details for a single role
+      # Example URL: /roles/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "RO"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/roles/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::Role.new(unenvelope_body(response.body))
+      end
+
+      # Updates a role object. Supports all of the fields supported when creating a
+      # role.
+      # Example URL: /roles/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "RO"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def update(identity, options = {}, custom_headers = {})
+        path = sub_url('/roles/:identity',           'identity' => identity)
+
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:put, path, options, custom_headers)
+
+        Resources::Role.new(unenvelope_body(response.body))
+      end
+
+      # Disables a role
+      # Example URL: /roles/:identity/actions/disable
+      #
+      # @param identity       # Unique identifier, beginning with "RO"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def disable(identity, options = {}, custom_headers = {})
+        path = sub_url('/roles/:identity/actions/disable',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::Role.new(unenvelope_body(response.body))
+      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
+        'roles'
+      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/subscription_service.rb

@@ -0,0 +1,133 @@
+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 GoCardless
+  module Services
+    # Service for making requests to the Subscription endpoints
+    class SubscriptionService < BaseService
+      # Creates a new subscription object
+      # Example URL: /subscriptions
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/subscriptions'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::Subscription.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
+      # list of your subscriptions.
+      # Example URL: /subscriptions
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/subscriptions'
+
+        response = make_request(:get, path, options, custom_headers)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Subscription
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          path: '/subscriptions',
+          options: options
+        ).enumerator
+      end
+
+      # Retrieves the details of a single subscription.
+      # Example URL: /subscriptions/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "SB"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/subscriptions/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::Subscription.new(unenvelope_body(response.body))
+      end
+
+      # Updates a subscription object.
+      # Example URL: /subscriptions/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "SB"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def update(identity, options = {}, custom_headers = {})
+        path = sub_url('/subscriptions/:identity',           'identity' => identity)
+
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:put, path, options, custom_headers)
+
+        Resources::Subscription.new(unenvelope_body(response.body))
+      end
+
+      # Immediately cancels a subscription; no more payments will be created under it.
+      # Any metadata supplied to this endpoint will be stored on the payment
+      # cancellation event it causes.
+      #
+      # This will fail with a cancellation_failed
+      # error if the subscription is already cancelled or finished.
+      # Example URL: /subscriptions/:identity/actions/cancel
+      #
+      # @param identity       # Unique identifier, beginning with "SB"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def cancel(identity, options = {}, custom_headers = {})
+        path = sub_url('/subscriptions/:identity/actions/cancel',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::Subscription.new(unenvelope_body(response.body))
+      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
+        'subscriptions'
+      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/user_service.rb

@@ -0,0 +1,148 @@
+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 GoCardless
+  module Services
+    # Service for making requests to the User endpoints
+    class UserService < BaseService
+      # <a name="user_exists"></a>Creates a new user object. Email addresses must be
+      # unique.
+      # Example URL: /users
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/users'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::User.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
+      # list of your users.
+      # Example URL: /users
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/users'
+
+        response = make_request(:get, path, options, custom_headers)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::User
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          path: '/users',
+          options: options
+        ).enumerator
+      end
+
+      # Retrieves the details of an existing user. In addition to the usual
+      # permissions based access rules, any user can access their own record.
+      # Example URL: /users/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "US"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/users/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::User.new(unenvelope_body(response.body))
+      end
+
+      # Updates a user object. Supports all of the fields supported when creating a
+      # user.
+      # Example URL: /users/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "US"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def update(identity, options = {}, custom_headers = {})
+        path = sub_url('/users/:identity',           'identity' => identity)
+
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:put, path, options, custom_headers)
+
+        Resources::User.new(unenvelope_body(response.body))
+      end
+
+      # Enables a user
+      # Example URL: /users/:identity/actions/enable
+      #
+      # @param identity       # Unique identifier, beginning with "US"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def enable(identity, options = {}, custom_headers = {})
+        path = sub_url('/users/:identity/actions/enable',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::User.new(unenvelope_body(response.body))
+      end
+
+      # Disables a user
+      # Example URL: /users/:identity/actions/disable
+      #
+      # @param identity       # Unique identifier, beginning with "US"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def disable(identity, options = {}, custom_headers = {})
+        path = sub_url('/users/:identity/actions/disable',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::User.new(unenvelope_body(response.body))
+      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
+        'users'
+      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