Class: GoCardlessPro::Services::BaseService

Inherits:

Object

• Object
• GoCardlessPro::Services::BaseService

Defined in:

lib/gocardless_pro/services/base_service.rb

Overview

Base Service that all services inherit from.

Direct Known Subclasses

BankDetailsLookupsService, CreditorBankAccountsService, CreditorsService, CustomerBankAccountsService, CustomerNotificationsService, CustomersService, EventsService, MandateImportEntriesService, MandateImportsService, MandatePdfsService, MandatesService, PaymentsService, PayoutItemsService, PayoutsService, RedirectFlowsService, RefundsService, SubscriptionsService

Instance Method Summary

• #envelope_key ⇒ Object

  Get the envelope key for the given service.

• #initialize(api_service) ⇒ BaseService constructor

  Create a new service instance to make requests against.

• #make_request(method, path, options = {}) ⇒ Object

  Make a request to the API using the API service instance.

Constructor Details

#initialize(api_service) ⇒ BaseService

Create a new service instance to make requests against

Parameters:

• api_service (GoCardlessPro::ApiService) —

  }] an instance of the ApiService

# File 'lib/gocardless_pro/services/base_service.rb', line 9

def initialize(api_service)
  @api_service = api_service
end

Instance Method Details

#envelope_key ⇒ Object

Get the envelope key for the given service. Children are expected to implement this method.

Raises:

• (NotImplementedError)

# File 'lib/gocardless_pro/services/base_service.rb', line 23

def envelope_key
  raise NotImplementedError
end

#make_request(method, path, options = {}) ⇒ Object

Make a request to the API using the API service instance

Parameters:

• method (Symbol) —

  the method to use to make the request

• path (String) —

  the URL (without the base domain) to make the request to

• options (Hash) (defaults to: {}) —

  the options hash - either the query parameters for a GET, or the body if POST/PUT

# File 'lib/gocardless_pro/services/base_service.rb', line 18

def make_request(method, path, options = {})
  @api_service.make_request(method, path, options.merge(envelope_key: envelope_key))
end