gocardless-pro 0.1.1 → 0.2.0

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

@@ -1,130 +0,0 @@
-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 ApiKey endpoints
-    class ApiKeyService < BaseService
-      # Creates a new API key.
-      # Example URL: /api_keys
-      # @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 = '/api_keys'
-        new_options = {}
-        new_options[envelope_key] = options
-        options = new_options
-        response = make_request(:post, path, options, custom_headers)
-
-        Resources::ApiKey.new(unenvelope_body(response.body))
-      end
-
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
-      # list of your API keys.
-      # Example URL: /api_keys
-      # @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 = '/api_keys'
-
-        response = make_request(:get, path, options, custom_headers)
-        ListResponse.new(
-          raw_response: response,
-          unenveloped_body: unenvelope_body(response.body),
-          resource_class: Resources::ApiKey
-        )
-      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: '/api_keys',
-          options: options
-        ).enumerator
-      end
-
-      # Retrieves the details of an existing API key.
-      # Example URL: /api_keys/:identity
-      #
-      # @param identity       # Unique identifier, beginning with "AK"
-      # @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('/api_keys/:identity',           'identity' => identity)
-
-        response = make_request(:get, path, options, custom_headers)
-
-        Resources::ApiKey.new(unenvelope_body(response.body))
-      end
-
-      # Updates an API key. Only the `name` and `webhook_url` fields are supported.
-      # Example URL: /api_keys/:identity
-      #
-      # @param identity       # Unique identifier, beginning with "AK"
-      # @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('/api_keys/:identity',           'identity' => identity)
-
-        new_options = {}
-        new_options[envelope_key] = options
-        options = new_options
-        response = make_request(:put, path, options, custom_headers)
-
-        Resources::ApiKey.new(unenvelope_body(response.body))
-      end
-
-      # Disables an API key. Once disabled, the API key will not be usable to
-      # authenticate any requests, and its `webhook_url` will not receive any more
-      # events.
-      # Example URL: /api_keys/:identity/actions/disable
-      #
-      # @param identity       # Unique identifier, beginning with "AK"
-      # @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('/api_keys/:identity/actions/disable',           'identity' => identity)
-
-        new_options = {}
-        new_options['data'] = options
-        options = new_options
-        response = make_request(:post, path, options, custom_headers)
-
-        Resources::ApiKey.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
-        'api_keys'
-      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/publishable_api_key_service.rb

@@ -1,130 +0,0 @@
-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 PublishableApiKey endpoints
-    class PublishableApiKeyService < BaseService
-      # Creates a publishable API key object.
-      # Example URL: /publishable_api_keys
-      # @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 = '/publishable_api_keys'
-        new_options = {}
-        new_options[envelope_key] = options
-        options = new_options
-        response = make_request(:post, path, options, custom_headers)
-
-        Resources::PublishableApiKey.new(unenvelope_body(response.body))
-      end
-
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
-      # list of your publishable API keys
-      # Example URL: /publishable_api_keys
-      # @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 = '/publishable_api_keys'
-
-        response = make_request(:get, path, options, custom_headers)
-        ListResponse.new(
-          raw_response: response,
-          unenveloped_body: unenvelope_body(response.body),
-          resource_class: Resources::PublishableApiKey
-        )
-      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: '/publishable_api_keys',
-          options: options
-        ).enumerator
-      end
-
-      # Returns all details about a single publishable API key
-      # Example URL: /publishable_api_keys/:identity
-      #
-      # @param identity       # Unique identifier, beginning with "PK"
-      # @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('/publishable_api_keys/:identity',           'identity' => identity)
-
-        response = make_request(:get, path, options, custom_headers)
-
-        Resources::PublishableApiKey.new(unenvelope_body(response.body))
-      end
-
-      # Updates a publishable API key. Only the `name` fields are supported. Any other
-      # fields passed will be ignored.
-      # Example URL: /publishable_api_keys/:identity
-      #
-      # @param identity       # Unique identifier, beginning with "PK"
-      # @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('/publishable_api_keys/:identity',           'identity' => identity)
-
-        new_options = {}
-        new_options[envelope_key] = options
-        options = new_options
-        response = make_request(:put, path, options, custom_headers)
-
-        Resources::PublishableApiKey.new(unenvelope_body(response.body))
-      end
-
-      # Disables a publishable API key. Once disabled, the publishable API key will
-      # not be usable to authenticate any requests.
-      # Example URL: /publishable_api_keys/:identity/actions/disable
-      #
-      # @param identity       # Unique identifier, beginning with "PK"
-      # @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('/publishable_api_keys/:identity/actions/disable',           'identity' => identity)
-
-        new_options = {}
-        new_options['data'] = options
-        options = new_options
-        response = make_request(:post, path, options, custom_headers)
-
-        Resources::PublishableApiKey.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
-        'publishable_api_keys'
-      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

@@ -1,127 +0,0 @@
-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/user_service.rb

@@ -1,148 +0,0 @@
-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