starling-ruby 0.1.0 → 0.2.0

data/lib/starling/services/contacts_service.rb

@@ -0,0 +1,73 @@
+module Starling
+  module Services
+    # A service for accessing the Contact's API's Get Contacts, Get Contact, Delete
+    # Contact and Create Contact and Account endpoints
+    class ContactsService < BaseService
+      # @param id [String] The Starling internal ID of the contact
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::ContactResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(id, params: {}, headers: {})
+        response = api_service.make_request(:get, "/contacts/#{id}", params: params,
+                                                                     headers: headers)
+        resource.new(response: response)
+      end
+
+      # @param id [String] The Starling internal ID of the contact
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the body
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Faraday::Response] the raw response from the Starling Bank API
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def delete(id, params: {}, headers: {})
+        api_service.make_request(:delete, "/contacts/#{id}", params: params,
+                                                             headers: headers)
+      end
+
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Array<Resources::ContactResource>]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def list(params: {}, headers: {})
+        response = api_service.make_request(:get, '/contacts', params: params,
+                                                               headers: headers)
+        build_collection_from_embedded_key(response, key: 'contacts', resource: resource)
+      end
+
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the body
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::ContactResource] the created contact
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def create(params:, headers: {})
+        post_response = api_service.make_request(:post, '/contacts', params: params,
+                                                                     headers: headers)
+
+        get_response = api_service.make_request(
+          :get,
+          convert_location_header_to_relative_path(post_response.headers['Location']),
+          headers: headers
+        )
+
+        resource.new(response: get_response)
+      end
+
+      private
+
+      def resource
+        Resources::ContactResource
+      end
+    end
+  end
+end

data/lib/starling/services/customer_service.rb

@@ -0,0 +1,25 @@
+module Starling
+  module Services
+    # A service for accessing the Customer API
+    class CustomerService < BaseService
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::CustomerResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(params: {}, headers: {})
+        response = api_service.make_request(:get, '/customers', params: params,
+                                                                headers: headers)
+        resource.new(response: response)
+      end
+
+      private
+
+      def resource
+        Resources::CustomerResource
+      end
+    end
+  end
+end

data/lib/starling/services/direct_debit_mandates_service.rb

@@ -0,0 +1,61 @@
+module Starling
+  module Services
+    # A service for accessing the Direct Debit Mandates API
+    class DirectDebitMandatesService < BaseService
+      # @param id [String] The Starling internal ID of the Direct Debit mandate
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::DirectDebitMandateResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(id, params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            "/direct-debit/mandates/#{id}",
+                                            params: params,
+                                            headers: headers)
+        resource.new(response: response)
+      end
+
+      # Cancels a Direct Debit mandate
+      #
+      # @param id [String] The Starling internal ID of the Direct Debit mandate
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the body
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Faraday::Response] the raw response from the Starling Bank API
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def delete(id, params: {}, headers: {})
+        api_service.make_request(:delete,
+                                 "/direct-debit/mandates/#{id}",
+                                 params: params,
+                                 headers: headers)
+      end
+
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Array<Resources::DirectDebitMandateResource>]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def list(params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            '/direct-debit/mandates',
+                                            params: params,
+                                            headers: headers)
+
+        build_collection_from_embedded_key(response, key: 'mandates', resource: resource)
+      end
+
+      private
+
+      def resource
+        Resources::DirectDebitMandateResource
+      end
+    end
+  end
+end

data/lib/starling/services/direct_debit_transactions_service.rb

@@ -0,0 +1,46 @@
+module Starling
+  module Services
+    # A service for accessing the Transaction Direct Debit API
+    class DirectDebitTransactionsService < BaseService
+      # @param id [String] The Starling internal ID of the transaction
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::DirectDebitTransactionResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(id, params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            "/transactions/direct-debit/#{id}",
+                                            params: params,
+                                            headers: headers)
+        resource.new(response: response)
+      end
+
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Array<Resources::DirectDebitTransactionResource>]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def list(params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            '/transactions/direct-debit',
+                                            params: params,
+                                            headers: headers)
+
+        build_collection_from_embedded_key(response,
+                                           key: 'transactions',
+                                           resource: resource)
+      end
+
+      private
+
+      def resource
+        Resources::DirectDebitTransactionResource
+      end
+    end
+  end
+end

data/lib/starling/services/inbound_faster_payments_transactions_service.rb

@@ -0,0 +1,46 @@
+module Starling
+  module Services
+    # A service for accessing the Transaction Faster Payment In API
+    class InboundFasterPaymentsTransactionsService < BaseService
+      # @param id [String] The Starling internal ID of the transaction
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::InboundFasterPaymentsTransactionResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(id, params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            "/transactions/fps/in/#{id}",
+                                            params: params,
+                                            headers: headers)
+        resource.new(response: response)
+      end
+
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Array<Resources::InboundFasterPaymentsTransactionResource>]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def list(params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            '/transactions/fps/in',
+                                            params: params,
+                                            headers: headers)
+
+        build_collection_from_embedded_key(response,
+                                           key: 'transactions',
+                                           resource: resource)
+      end
+
+      private
+
+      def resource
+        Resources::InboundFasterPaymentsTransactionResource
+      end
+    end
+  end
+end

data/lib/starling/services/mastercard_transactions_service.rb

@@ -0,0 +1,30 @@
+module Starling
+  module Services
+    # A service for accessing the Transaction Mastercard API
+    class MastercardTransactionsService < BaseService
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Array<Resources::MastercardTransactionResource>]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def list(params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            '/transactions/mastercard',
+                                            params: params,
+                                            headers: headers)
+
+        build_collection_from_embedded_key(response,
+                                           key: 'transactions',
+                                           resource: resource)
+      end
+
+      private
+
+      def resource
+        Resources::MastercardTransactionResource
+      end
+    end
+  end
+end

data/lib/starling/services/me_service.rb

@@ -0,0 +1,26 @@
+module Starling
+  module Services
+    # A service for accessing the Who Am I API
+    class MeService < BaseService
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::MeResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(params: {}, headers: {})
+        response = api_service.make_request(:get, '/me', params: params,
+                                                         headers: headers)
+
+        resource.new(response: response)
+      end
+
+      private
+
+      def resource
+        Resources::MeResource
+      end
+    end
+  end
+end

data/lib/starling/services/merchant_locations_service.rb

@@ -0,0 +1,34 @@
+module Starling
+  module Services
+    # A service for accessing the Merchant API's Get Location endpoint
+    class MerchantLocationsService < BaseService
+      # @param merchant_id [String] The Starling internal ID of the merchant the merchant
+      #                             location belongs to
+      # @param merchant_location_id [String] The Starling internal ID of the merchant
+      #                                      location
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::MerchantLocationResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(merchant_id, merchant_location_id, params: {}, headers: {})
+        response = api_service.make_request(
+          :get,
+          "/merchants/#{merchant_id}/locations/#{merchant_location_id}",
+          params: params,
+          headers: headers
+        )
+
+        resource.new(response: response)
+      end
+
+      private
+
+      def resource
+        Resources::MerchantLocationResource
+      end
+    end
+  end
+end

data/lib/starling/services/merchants_service.rb

@@ -0,0 +1,26 @@
+module Starling
+  module Services
+    # A service for accessing the Merchant API's Get Merchant endpoint
+    class MerchantsService < BaseService
+      # @param id [String] The Starling internal ID of the merchant
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources:MerchantResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(id, params: {}, headers: {})
+        response = api_service.make_request(:get, "/merchants/#{id}", params: params,
+                                                                      headers: headers)
+        resource.new(response: response)
+      end
+
+      private
+
+      def resource
+        Resources::MerchantResource
+      end
+    end
+  end
+end

data/lib/starling/services/outbound_faster_payments_transactions_service.rb

@@ -0,0 +1,46 @@
+module Starling
+  module Services
+    # A service for accessing the Transaction Faster Payment Out API
+    class OutboundFasterPaymentsTransactionsService < BaseService
+      # @param id [String] The Starling internal ID of the transaction
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::OutboundFasterPaymentsTransactionResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(id, params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            "/transactions/fps/out/#{id}",
+                                            params: params,
+                                            headers: headers)
+        resource.new(response: response)
+      end
+
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Array<Resources::OutboundFasterPaymentsTransactionResource>]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def list(params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            '/transactions/fps/out',
+                                            params: params,
+                                            headers: headers)
+
+        build_collection_from_embedded_key(response,
+                                           key: 'transactions',
+                                           resource: resource)
+      end
+
+      private
+
+      def resource
+        Resources::OutboundFasterPaymentsTransactionResource
+      end
+    end
+  end
+end

data/lib/starling/services/payments_service.rb

@@ -0,0 +1,30 @@
+module Starling
+  module Services
+    # A service for accessing the Payment API
+    class PaymentsService < BaseService
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Array<Resources::PaymentResource>]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def list(params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            '/payments/scheduled',
+                                            params: params,
+                                            headers: headers)
+
+        build_collection_from_embedded_key(response,
+                                           key: 'paymentOrders',
+                                           resource: resource)
+      end
+
+      private
+
+      def resource
+        Resources::PaymentResource
+      end
+    end
+  end
+end