Class: GoCardlessPro::Services::BankAuthorisationsService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/gocardless_pro/services/bank_authorisations_service.rb

Overview

Service for making requests to the BankAuthorisation endpoints

Instance Method Summary collapse

Methods inherited from BaseService

#initialize, #make_request, #sub_url

Constructor Details

This class inherits a constructor from GoCardlessPro::Services::BaseService

Instance Method Details

#create(options = {}) ⇒ Object

Create a Bank Authorisation. Example URL: /bank_authorisations

Parameters:

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

    parameters as a hash, under a params key.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/gocardless_pro/services/bank_authorisations_service.rb', line 16

def create(options = {})
  path = '/bank_authorisations'

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params][envelope_key] = params

  options[:retry_failures] = true

  begin
    response = make_request(:post, path, options)

    # Response doesn't raise any errors until #body is called
    response.tap(&:body)
  rescue InvalidStateError => e
    if e.idempotent_creation_conflict?
      case @api_service.on_idempotency_conflict
      when :raise
        raise IdempotencyConflict, e.error
      when :fetch
        return get(e.conflicting_resource_id)
      end
    end

    raise e
  end

  return if response.body.nil?

  Resources::BankAuthorisation.new(unenvelope_body(response.body), response)
end

#get(identity, options = {}) ⇒ Object

Get a single bank authorisation. Example URL: /bank_authorisations/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “BAU”.

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

    parameters as a hash, under a params key.



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/gocardless_pro/services/bank_authorisations_service.rb', line 53

def get(identity, options = {})
  path = sub_url('/bank_authorisations/:identity', {
                   'identity' => identity
                 })

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

  Resources::BankAuthorisation.new(unenvelope_body(response.body), response)
end