Class: GoCardlessPro::Services::CreditorBankAccountsService

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

Overview

Service for making requests to the CreditorBankAccount 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

#all(options = {}) ⇒ Object

Get a lazily enumerated list of all the items returned. This is similar to the ‘list` method but will paginate for you automatically.

Otherwise they will be the body of the request.

Parameters:

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

    parameters as a hash. If the request is a GET, these will be converted to query parameters.



70
71
72
73
74
75
 
# File 'lib/gocardless_pro/services/creditor_bank_accounts_service.rb', line 70

def all(options = {})
  Paginator.new(
    service: self,
    options: options
  ).enumerator
end

#create(options = {}) ⇒ Object

Creates a new creditor bank account object. Example URL: /creditor_bank_accounts

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/creditor_bank_accounts_service.rb', line 16

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

  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::CreditorBankAccount.new(unenvelope_body(response.body), response)
end

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

Immediately disables the bank account, no money can be paid out to a disabled account.

This will return a ‘disable_failed` error if the bank account has already been disabled.

A disabled bank account can be re-enabled by creating a new bank account resource with the same details. Example URL: /creditor_bank_accounts/:identity/actions/disable

Parameters:

  • identity —

    # Unique identifier, beginning with “BA”.

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

    parameters as a hash, under a params key.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/gocardless_pro/services/creditor_bank_accounts_service.rb', line 108

def disable(identity, options = {})
  path = sub_url('/creditor_bank_accounts/:identity/actions/disable', {
                   'identity' => identity
                 })

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

  options[:retry_failures] = false

  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::CreditorBankAccount.new(unenvelope_body(response.body), response)
end

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

Retrieves the details of an existing creditor bank account. Example URL: /creditor_bank_accounts/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “BA”.

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

    parameters as a hash, under a params key.



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/gocardless_pro/services/creditor_bank_accounts_service.rb', line 82

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

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

#list(options = {}) ⇒ Object

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditor bank accounts. Example URL: /creditor_bank_accounts

Parameters:

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

    parameters as a hash, under a params key.



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

def list(options = {})
  path = '/creditor_bank_accounts'

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  ListResponse.new(
    response: response,
    unenveloped_body: unenvelope_body(response.body),
    resource_class: Resources::CreditorBankAccount
  )
end